SpringCloud、Swagger、Lombok、Mybatis-Plus的常用注解总结

springcloud常用注解

@Controller 控制层，里面有多个连接
@Service 业务层，一般对于接口和实现
@Qualifier 如果一个接口有多个实现，那么注入时候加上唯一标示
@Repository 一般的dao层
@Autowired 自动注入依赖
@Resource bean的注入，同Autowired 有相同的功能。
说明：
	共同点：@Resource和@Autowired都可以作为注入属性的修饰，在接口仅有单一实现类时，两个注解的修饰效果相同，可以互相替换，不影响使用。
	不同点：
	@Resource是Java自己的注解，@Resource有两个属性是比较重要的，分是name和type；Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。所以如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不指定name也不指定type属性，这时将通过反射机制使用byName自动注入策略。
	@Autowired是spring的注解，是spring2.5版本引入的，Autowired只根据type进行注入，不会去匹配name。如果涉及到type无法辨别注入对象时，那需要依赖@Qualifier或@Primary注解一起来修饰。
@Component定义其它组件（比如访问外部服务的组件）
@RequestMapping （value=’’,method={RequestMethod。GET或者POSt}）绑定url
@RequestParam (value=’’ required=false)绑定参数,将客户端请求中的参数值映射到相应方法的参数上;
@ModelAttribute 一般用于controller层，呗注解的方法会在所以mapping执行之前执行，并且可以绑定参数到Model model里面。
@Transactional （readOnly=true）注解式事务
@TransactionalEventListener用于配置事务的回调方法，可以在事务提交前、提交后、完成后以及回滚后几个阶段接受回调事件。
@Value（“${}”）可以注入properties里面的配置项
@ControllerAdvice 是spring3提供的新注解
@ExceptionHandler 如果在controller方法遇到异常，就会调用含有此注解的方法。
@InitBinder 一般用于controller 可以将所以form 讲所有传递进来的string 进行html编码，防止xss攻击，比如可以将字符串类型的日期转换成date类型
@EnableCaching 注解自动化配置合适的缓存管理器。
@EnableWebSecurity 注解开启spring security的功能，集成websercrityconfigureadapter。
@SringBootApplication相当于@configuration，@EnableAutoConfiguation @ComponentScan三个注解合用。
@EnableDiscoveryclient 注册应用为Eureka客户端应用，以获得服务发现的能力
@EnableAdminServer 使用admin监控应用。
@EnableEurekaClient配置本应用将使用服务注册和服务发现，注意：注册和发现用这个注解。
@EnableEurekaServer 启动一个服务注册中心
@EnableHystrix表示启动断路器，断路器依赖于服务注册和发现。
@HystrixCommand注解方法失败后，系统将西东切换到fallbackMethod方法执行。指定回调方法
@EnableAutoConfiguration spring boot自动配置，尝试根据你添加的jar依赖自动配置你的spring应用。
@ComponentScan 表示将该类自动发现并注册bean 可以自动收集所有的spring组件
@Comfiguration 相当于传统的xml配置文件
@Import 导入其他配置类
@ImportResource用来 加载xml配置文件
@FeignClient注解中的fallbank属性指定回调类
@RestController 返回json字符串的数据，直接可以编写RESTFul的接口;
@CrossOrigin 可以处理跨域请求，让你能访问不是一个域的文件;
@ApiOperation 首先@ApiOperation注解不是Spring自带的，它是是swagger里的注解@ApiOperation是用来构建Api文档的@ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”；
@SpringBootApplication　　申明让spring boot自动给程序进行必要的配置，等价于以默认属性使用@Configuration，@EnableAutoConfiguration和@ComponentScan;
@RefreshScope　如果代码中需要动态刷新配置，在需要的类上加上该注解就行。但某些复杂的注入场景下，这个注解使用不当，配置可能仍然不动态刷新;
@FeignClient　springboot调用外部接口:声明接口之后，在代码中通过@Resource注入之后即可使用。@FeignClient标签的常用属性如下：name：指定FeignClient的名称，如果项目使用了Ribbon，name属性会作为微服务的名称，用于服务发现
url: url一般用于调试，可以手动指定@FeignClient调用的地址decode404:当发生http 404错误时，如果该字段位true，会调用decoder进行解码，否则抛出FeignException
configuration: Feign配置类，可以自定义Feign的Encoder、Decoder、LogLevel、Contractfallback: 定义容错的处理类，当调用远程接口失败或超时时，会调用对应接口的容错逻辑，fallback指定的类必须实现@FeignClient标记的接口
fallbackFactory: 工厂类，用于生成fallback类示例，通过这个属性我们可以实现每个接口通用的容错逻辑，减少重复的代码path: 定义当前FeignClient的统一前缀
@EnableFeignClients 开启Spring Cloud Feign的支持
@EnableCircuitBreaker 开启断路器功能
@LoadBalanced 开启客户端负载均衡
@WebAppConfiguration 开启Web 应用的配置，用于模拟ServletContext
@RibbonClient，这个注解用来为负载均衡客户端做一些自定义的配置，可以进一步配置或自定义从哪里获取服务端列表、负载均衡策略、Ping也就是服务鉴活策略等等

swagger常用注解

@API
使用在类上，表明是swagger资源，@API拥有两个属性:value、tags。
@ApiOperation
使用于在方法上，表示一个http请求的操作源码中属性太多，记几个比较常用的：
value用于方法描述
notes用于提示内容
tags可以重新分组（视情况而用）
@ApiParam
使用在方法上或者参数上，字段说明；表示对参数的添加元数据（说明或是否必填等）
name–参数名
value–参数说明
required–是否必填
@ApiModel()
使用在类上，表示对类进行说明，用于参数用实体类接收
value–表示对象名
description–描述
@ApiModelProperty()
使用在方法，字段上，表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏

lombok常用注解

@EqualsAndHashCode
实现equals()方法和hashCode()方法
@ToString
实现toString()方法
@Data
注解在类上；提供类所有属性的 getting 和 setting 方法，此外还提供了equals、canEqual、hashCode、toString 方法
@Setter　　　　　　　　　　
注解在属性上；为属性提供 setting 方法
@Getter　　　　　　　　　　
注解在属性上；为属性提供 getting 方法
@Log4j 　　　　　　　　　　
注解在类上；为类提供一个 属性名为log 的 log4j 日志对象
@NoArgsConstructor　　　　
注解在类上；为类提供一个无参的构造方法
@AllArgsConstructor　　　　
注解在类上；为类提供一个全参的构造方法
@Cleanup　　　　　　　　
关闭流
@Synchronized
对象同步
@SneakyThrows
抛出异常
@ConfigurationProperties　　　　
把同类的配置信息自动封装成实体类:可以使属性文件中的值和类中的属性对应起来;
使用方式有两种 :1、在类上使用该注解 2、在工厂方法上使用该注解 （@bean）注意：在springBoot中除了使用这个注解读取属性文件值外，还可以用@Value注解。

mybatis-plus常用注解

@TableName：映射数据库表名，在你创建的实体类类名与数据库表明不同时可以用@TableName(value = “数据库表名”)
@TableFieId：映射非主键字段
value属性：是映射的字段名。
exist属性：表示是否为数据库字段（默认是true），如果实体类中的成员变量在数据库中没有对应的字段，则可以使用exist，一般VO，DTO中用的比较多。
select属性：表示是否查询该字段。
fill属性：表示是否自动填充，将对象存入数据库的时候，由mybatis plus自动给某些字段赋值，create_time,update_time等用的比较多。@TableField(fill = FieldFill.INSERT)，在将对象存入数据库的时候，由mybatis plus自动给某些字段赋值。@TableField(fill = FieldFill.INSERT_UPDATE)，这里比上面多了个"_UPDATE"，在第一插入的时候我们的updateTime变量应该是和createTime的时间相同，但在后面修数据的时候“_UPDATE”就启动用了，mybatis plus自动将你修改数据的时间给数据库对应的字段赋值。
@TableId:设置主键映射
value属性是映射注解字段的名字
type属性设置主键的类型，主键的生成策略
@Version：标记乐观锁，通过version字段保证数据的安全性，当修改数据的时候，会以version作为条件，当条件成立的时候才会修改成功(防止多线程多次更改一个数据)。
@TableLogic：表字段逻辑处理注解（逻辑删除）