SpringCloud常用注解总结

不念不忘少年蓝@ 2022-01-23 11:17 232阅读 0赞

公司正在用springcloud微服务改造老项目，为了方便查找和学习，汇总一些常用的注解。使用过程中定期更新。

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也就是服务鉴活策略等等
    @PathVariable   获取参数。   
    @JsonBackReference  解决嵌套外链问题。 
    @RepositoryRestResourcepublic  配合spring-boot-starter-data-rest使用

常用的 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注解。

JPA注解：

1、@Entity：@Table(name=”“)：表明这是一个实体类。一般用于jpa这两个注解一般一块使用，但是如果表名和实体类名相同的话，@Table可以省略。
    2、@MappedSuperClass:用在确定是父类的entity上。父类的属性子类可以继承。
    3、@NoRepositoryBean:一般用作父类的repository，有这个注解，Spring不会去实例化该repository。
    4、@Column：如果字段名与列名相同，则可以省略。
    5、@Id：表示该属性为主键。
    6、@GeneratedValue(strategy=GenerationType.SEQUENCE,generator=    “repair_seq”)：表示主键生成策略是sequence  （可以为Auto、IDENTITY、native等，Auto表示可在多个数据库间切换），指定sequence的名字是repair_seq。
    7、@SequenceGeneretor(name = “repair_seq”, sequenceName =    “seq_repair”, allocationSize =   
    1)：name为sequence的名称，以便使用，sequenceName为数据库的sequence名称，两个名称可以一致。
    8、@Transient：表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。
      如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic。
    9、@Basic(fetch=FetchType.LAZY)：标记可以指定实体属性的加载方式。
    10、@JsonIgnore：作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。
    11、@JoinColumn（name=”loginId”）:一对一：本表中指向另一个表的外键。一对多：另一个表指向本表的外键。
    12、@OneToOne、@OneToMany、@ManyToOne：对应hibernate配置文件中的一对一，一对多，多对一。