Springboot注解

原文链接：https://www.cnblogs.com/ldy-blogs/p/8550406.html

实体类注解

@Basic(fetch=FetchType.LAZY)：标记可以指定实体属性的加载方式

@Column(name="PA_PA_ID",length=10)：标识一些字段特性，字段别名，是否允许为空，是否唯一，是否进行插入和更新（比如由MySQL自动维护），如果字段名与列名相同，则可以省略。

@Data：是 lombok 的注解，自动生成Getter，Setter，toString，构造函数等

@DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss")：时间格式说明，解决前台string类型与后台date类型的转换

@DynamicUpdate

@DynamicInsert 注解可以动态的生成insert、update 语句，默认会生成全部的update

@Entity：注解这是个实体类

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

@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”)：表示主键生成策略是sequence（可以为Auto、IDENTITY、native等，Auto表示可在多个数据库间切换），指定sequence的名字是repair_seq。

@GenericGenerator(name ="pkGenerator",strategy="foreign" ,parameters={@Parameter(name="property",value="praxis")})：通用生成程序

@Id：表示该属性为主键。

@JsonProperty(value = "email")：定义 Spring JSON 别名

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

@JoinColumn（name=”loginId”）:

     1.一对一和多对一的@JoinColumn注解的都是在“主控方”，都是本表指向外表的外键名称。
     2.一对多的@JoinColumn注解在“被控方”，即一的一方，指的是外表中指向本表的外键名称。
     3.多对多中，joinColumns写的都是本表在中间表的外键名称，

可参考详解链接：@JoinColumn 详解

@JsonFormat(pattern="yyyy-MM-dd HH:mm:ss")：定义 JSON 时进行格式化操作

@Lob

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

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

@NotFound(action=NotFoundAction.IGNORE)

@OrderBy(value="orderIndex")

@OneToOne、@OneToMany、@ManyToOne：对应hibernate配置文件中的一对一，一对多，多对一。

@OneToOne(cascade=CascadeType.ALL)：在一对一的关系中，只需在主控方（数据总表）内注明@OneToOne，而被控方（员工表）只是作为外键，不需任何特殊标记。

@ManyToMany

• 在多对多的情况下，如部门表和员工表之间的关系（暂不去深究一个员工是否能有多个部门的身份）。
• 部门表和员工表只需在引用对象集合上注明@ManyToMany即可，其中部门表的写法如上段代码，员工表的写法如下段代码。
• 在多对多的映射中会生成一张中间表，其表名和字段名均有默认的命名规则，若需指定表名和字段名，只需在两者的一方或双方写上@JoinTable注解即可，详情如下代码段，表名属性name=”table_name”，与joinColumns属性是同级属性，即写在其前即可。
• 同时需要注意，如果需要将员工表对象或者部门表对象转为JSON数据的时候，为了防止出现无限循环包含对方，需要在一方的引用对方对象的set方法（Set对象的set方法）上写上注解@JsonBackReference

@PrimaryKeyJoinColumn：

@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1)：name为sequence的名称，以便使用，sequenceName为数据库的sequence名称，两个名称可以一致。

@Transient：表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic。

@Table(name = "PRAXISKNOWLEDGE")：注解表相关，如别名等

@Version:

Annotations注解：

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

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

@Component：泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。可配合CommandLineRunner使用，在程序启动后执行一些基础任务。

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

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

@ComponentScan：表示将该类自动发现扫描组件。个人理解相当于，如果扫描到有@Component、@Controller、@Service等这些注解的类，并注册为Bean，可以自动收集所有的Spring组件，包括@Configuration类。我们经常使用@ComponentScan注解搜索beans，并结合@Autowired注解导入。可以自动收集所有的Spring组件，包括@Configuration类。我们经常使用@ComponentScan注解搜索beans，并结合@Autowired注解导入。如果没有配置的话，Spring Boot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类。

@EnableAutoConfiguration：Spring Boot自动配置（auto-configuration）：尝试根据你添加的jar依赖自动配置你的Spring应用。例如，如果你的classpath下存在HSQLDB，并且你没有手动配置任何数据库连接beans，那么我们将自动配置一个内存型（in-memory）数据库”。你可以将      @EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类，你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。

@EnableAutoConfiguration注解。其中@ComponentScan让spring Boot扫描到Configuration类并把它加入到程序上下文。自动配置。

@Import：用来导入其他配置类。

@ImportResource：用来加载xml配置文件。

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

@JsonBackReference解决嵌套外链问题。

@PathVariable获取参数。

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

@RestController注解是@Controller和@ResponseBody的合集,表示这是个控制器bean,并且是将函数的返回值直 接填入HTTP响应体中,是REST风格的控制器。

@RepositoryRestResourcepublic配合spring-boot-starter-data-rest使用。

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

@RequestMapping(“/test”)

@ResponseBody

public String test(){

return”ok”;

}

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

@Resource(name=”name”,type=”type”)：没有括号内内容的话，默认byName。与@Autowired干类似的事。

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

@Service：一般用于修饰service层的组件

@SpringBootApplication：包含了@ComponentScan、@Configuration和

@Value：注入Spring boot application.properties配置的属性的值。

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）：用在方法上面表示遇到这个异常就执行以下方法。