springBoot+Mybatis注解大全

springBoot+Mybatis注解大全

https://www.jianshu.com/p/baf4185cb9e6

锚点目录：
一、SpringBoot 快速整合Mybatis
二、Spring注解(annotations)详解
三、个人笔记
四、构建WEB网站入口知识

http://blog.didispace.com/springbootweb/
五、Spring Boot构建RESTful API与单元测试
http://blog.didispace.com/springbootrestfulapi/

一、SpringBoot 快速整合Mybatis

（去XML化+注解详解）
https://www.jianshu.com/p/828d2bd12b2f

application-test.properties：测试环境
application-dev.properties：开发环境
application-prod.properties：生产环境

二、Spring注解(annotations)详解

annotations在Java里面可以用来和public、static等关键字一样来修饰类名、方法名、变量名。修饰的作用描述这个数据是做什么用的，差不多和public描述这个数据是公有的一样

@SpringBootApplication：

告诉spring boot自动给当前项目进行必要的配置，这个配置等同于：
@Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三个配置。

package com.example.myproject; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } 

@ResponseBody：

表示该方法的返回结果直接写入HTTP response body中，一般在异步获取数据时使用，用于构建RESTful的api。在使用@RequestMapping后，返回值通常解析为跳转路径，加上@responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。比如异步获取json数据，加上@responsebody后，会直接返回json数据。该注解一般会配合@RequestMapping一起使用。示例代码：

@RequestMapping(“/test”) @ResponseBody public String test(){ return”ok”; } 

@Controller：

用于定义控制器类，在spring 项目中由控制器负责将用户发来的URL请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@RequestMapping。示例代码：

@Controller @RequestMapping(“/demoInfo”) public class DemoController { @Autowired private DemoInfoService demoInfoService; @RequestMapping("/hello") public String hello(Map<String,Object> map){ System.out.println("DemoController.hello()"); map.put("hello","from TemplateController.helloHtml"); //会使用hello.html或者hello.ftl模板进行渲染显示. return"/hello"; } } 

@RestController：

用于标注控制层组件(如struts中的action)，@ResponseBody和@Controller的合集。示例代码：

package com.kfit.demo.web; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping(“/demoInfo2”) public class DemoController2 { @RequestMapping("/test") public String test(){ return"ok"; } } 

@RequestMapping：

提供路由信息，负责URL到Controller中的具体函数的映射。

@EnableAutoConfiguration：

Spring Boot自动配置（auto-configuration）：
尝试根据你添加的jar依赖自动配置你的Spring应用。
例如，如果你的classpath下存在HSQLDB，并且你没有手动配置任何数据库连接beans，那么我们将自动配置一个内存型（in-memory）数据库”。

你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。
如果发现应用了你不想要的特定自动配置类，你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。

@ComponentScan：

表示将该类自动发现扫描组件。
个人理解相当于，如果扫描到有@Component、@Controller、@Service等这些注解的类，并注册为Bean，可以自动收集所有的Spring组件，包括@Configuration类。

我们经常使用@ComponentScan注解搜索beans，并结合@Autowired注解导入。如果没有配置的话，Spring Boot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类。

@Configuration：

相当于传统的xml配置文件，如果有些第三方库需要用到xml文件，建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。

@Import：

用来导入其他配置类。

@ImportResource：

用来加载xml配置文件。

@Autowired：

自动导入依赖的bean

@Service：

一般用于修饰service层的组件

@Repository：

使用@Repository注解可以确保DAO或者repositories提供异常转译，这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置，同时也不需要为它们提供XML配置项。

@Bean：

用@Bean标注方法等价于XML中配置的bean。

@Value：

注入Spring boot application.properties配置的属性的值。示例代码：

@Value(value = “#{message}”) private String message; 

@Inject：

等价于默认的@Autowired，只是没有required属性；

@Component：

泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

@Bean:

相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

@AutoWired：

自动导入依赖的bean。byType方式。
把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。
当加上（required=false）时，就算找不到bean也不报错。

@Qualifier：

当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入，但能进行更细粒度的控制如何选择候选者，具体使用方式如下：

@Resource(name=”name”,type=”type”)：

没有括号内内容的话，默认byName。
与@Autowired干类似的事。

三、JPA注解

@Entity：

@Table(name=”“)：
表明这是一个实体类。一般用于jpa这两个注解一般一块使用，但是如果表名和实体类名相同的话，@Table可以省略

@MappedSuperClass:

用在确定是父类的entity上。父类的属性子类可以继承。

@NoRepositoryBean:

一般用作父类的repository，有这个注解，spring不会去实例化该repository。

@Column：

如果字段名与列名相同，则可以省略。

@Id：

表示该属性为主键。

@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”)：

表示主键生成策略是sequence（可以为Auto、IDENTITY、native等，Auto表示可在多个数据库间切换），指定sequence的名字是repair_seq。

@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1)：

name为sequence的名称，以便使用，sequenceName为数据库的sequence名称，两个名称可以一致。

@Transient：

表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic。@Basic(fetch=FetchType.LAZY)：
标记可以指定实体属性的加载方式

@JsonIgnore：

作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。

@JoinColumn（name=”loginId”）:

一对一：本表中指向另一个表的外键。一对多：另一个表指向本表的外键。

@OneToOne、@OneToMany、@ManyToOne：

对应hibernate配置文件中的一对一，一对多，多对一。

springMVC相关注解

@RequestMapping：

@RequestMapping(“/path”)

表示该控制器处理所有“/path”的UR L请求。RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。
用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。该注解有六个属性：
params:指定request中必须包含某些参数值是，才让该方法处理。
headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。
value:指定请求的实际地址，指定的地址可以是URI Template 模式
method:指定请求的method类型， GET、POST、PUT、DELETE等
consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html;
produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回

@RequestParam：

用在方法的参数前面。

@RequestParam String a =request.getParameter(“a”)。 

@PathVariable:路径变量。如

@RequestMapping(“user/get/mac/{macAddress}”) public String getByMacAddress(@PathVariable String macAddress){ //do something; } 

参数与大括号里的名字一样要相同。

全局异常处理

@ControllerAdvice：

包含@Component。可以被扫描到。统一处理异常。

@ExceptionHandler（Exception.class）：

用在方法上面表示遇到这个异常就执行以下方法。

三、个人笔记

spring-boot-configuration-processor

通过使用spring-boot-configuration-processor jar， 你可以从被@ConfigurationProperties注解的节点轻松的产生自己的配置元数据文件。该jar包含一个在你的项目编译时会被调用的Java注解处理器。想要使用该处理器，你只需简单添加spring-boot-configuration-processor依赖。

好了，官方已经说得很清楚了，这个依赖主要可以在代码中轻松的使用@ConfigurationProperties注解注入属性文件配置的属性值。

<dependency>  
          <groupId>org.springframework.boot</groupId>  
          <artifactId>spring-boot-configuration-processor</artifactId>  
          <optional>true</optional> </dependency> 

Spring提供如下几个Annotation来标注Spring Bean：

@Component: 标注一个普通的Spring Bean类
@Controller: 标注一个控制器组件类
@Service: 标注一个业务逻辑组件类
@Repository: 标注一个DAO组件类

MyBatis 注解方式时，找不到Beans的提示解决办法(二个）：

方法一：
使用注解告诉编辑器忽略指定的错误
@SuppressWarnings(“”)
@SuppressWarnings({})
@SuppressWarnings(value={})

@SuppressWarnings(value={"unchecked", "deprecation"}) 等同于 @SuppressWarnings("unchecked", "deprecation") ------------------- all to suppress all warnings （抑制所有警告） boxing to suppress warnings relative to boxing/unboxing operations （抑制装箱、拆箱操作时候的警告） cast to suppress warnings relative to cast operations （抑制映射相关的警告） dep-ann to suppress warnings relative to deprecated annotation （抑制启用注释的警告） deprecation to suppress warnings relative to deprecation （抑制过期方法警告） fallthrough to suppress warnings relative to missing breaks in switch statements （抑制确在switch中缺失breaks的警告） finally to suppress warnings relative to finally block that don’t return （抑制finally模块没有返回的警告） hiding to suppress warnings relative to locals that hide variable（） incomplete-switch to suppress warnings relative to missing entries in a switch statement (enum case ) (忽略没有完整的switch语句) nls to suppress warnings relative to non-nls string literals (忽略非nls格式的字符) null to suppress warnings relative to null analysis (忽略对null的操作) rawtypes to suppress warnings relative to un-specific types when using generics on class params (使用generics时忽略没有指定相应的类型) restriction to suppress warnings relative to usage of discouraged or forbidden references serial to suppress warnings relative to missing serialVersionUID field for a serializable class (忽略在serializable类中没有声明serialVersionUID变量) static-access to suppress warnings relative to incorrect static access （抑制不正确的静态访问方式警告) synthetic-access to suppress warnings relative to unoptimized access from inner classes （抑制子类没有按最优方法访问内部类的警告） unchecked to suppress warnings relative to unchecked operations （抑制没有进行类型检查操作的警告） unqualified-field-access to suppress warnings relative to field access unqualified （抑制没有权限访问的域的警告） unused to suppress warnings relative to unused code （抑制没被使用过的代码的警告） 

方法二：

 

image.png

MyBatis Generator (MBG)

是一个Mybatis的代码生成器，它可以帮助我们根据数据库中表的设计生成对应的实体类，xml Mapper文件，接口以及帮助类
(也就是我们可以借助该类来进行简单的CRUD操作)
这样就避免了我们每使用到一张表的数据就需要手动去创建对应的类和xml文件，这就帮我们节约了大量的时间去开发和业务逻辑有关的功能，但是如果对联合查询和存储过程您仍然需要手写SQL和对象

@RequestMapping

//单个url写法 @RequestMapping(value = "hello",method = RequestMethod.GET) //多个url写法 @RequestMapping(value = {"hello","hi"},method = RequestMethod.GET) ========================= @RestController //将类视为一个功能模块，模块中的输出是子路径 @RequestMapping(value = "Ly") public class HelloController { @Autowired private GirlProperties girlProperties; @RequestMapping(value = {"hello","hi"},method = RequestMethod.GET) public String say(){ return girlProperties.toString(); } } 

@RestController

效果等同于：

@RestController = @Controller + @ResponseBody 

 

image.png

//@PathVariable 获取路径中的参数 //@RequestParam 获取传统url中的静态参数 //@GetMapping

作者：酷泡泡
链接：https://www.jianshu.com/p/baf4185cb9e6
来源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。