微服务中常用注解(持续更新)

秒速五厘米 2023-01-18 04:01 253阅读 0赞

**1.@Component**  
用来标注将普通类交给Spring管理，当此类不属于mapper、service、controller，就可以使用此注解。  
交给Spring管理就是让spring帮你创建对象，可以通过注入的方式获得对象引用。

**2.@Repository**  
用来标注将mapper层接口的实现类交给Spring管理。  
交给Spring管理就是让spring帮你创建对象，可以通过注入的方式获得对象引用。

**3.@Service**  
用来标注将业务层实现类交给Spring管理。  
交给Spring管理就是让spring帮你创建对象，可以通过注入的方式获得对象引用。

**4.@Controller**  
用来标注将控制层Class交给Spring管理。  
交给Spring管理就是让spring帮你创建对象，可以通过注入的方式获得对象引用。

**5.@Bean**  
用于告诉方法，产生一个Bean对象，然后将这个Bean对象交给Spring管理。(和xml配置中的bean标签的作用是一样的，可用于配置类当中)

**6.@Configuration**  
用于定义配置类，可替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext  
或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。  
@Configuration注解的类会在项目启动的时候加载。

**7.@Mapper（Mybatis注解）**  
添加了@Mapper注解之后的接口会在编译时生成相应的实现类

**8.@MapperScan（Mybatis注解）**  
指定要变成实现类的接口所在的包，然后包下面的所有接口在编译之后都会生成相应的实现类。

**9.@ComponentScan**  
用来寻找bean。ComponentScan做的事情就是告诉Spring从哪里找到bean。@SpringBootApplication注解中包含@ComponentScan注解。  
如果你的其他包都在使用了@SpringBootApplication注解的main app所在的包及其下级包，则你什么都不用做，SpringBoot会自动帮你把其他包都扫描了。

**10.@SpringBootApplication（用于SpringBoot项目的启动类）**  
spring boot提供的一个统一的注解。@SpringBootApplication =@Configuration + @EnableAutoConfiguration + @ComponentScan。  
@Configuration用于定义配置类。@EnableAutoConfiguration用于自动为你添加需要的配置。@ComponentScan用于扫描bean的

**11.@Resource（java注解）和@Autowired（Spring注解，推荐使用）**  
给变量注入bean时使用。

**12.@responseBody（将后端查询到的数据转为json格式返回给前端）**  
将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据。

**13.@RequestBody（将前端传来的参数放到方法的参数中）**  
将 HTTP 请求正文插入方法中，使用适合的 HttpMessageConverter 将请求体写入某个对象。  
用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的)；GET方式无请求体，  
所以使用@RequestBody接收数据时，前端不能使用GET方式提交数据，而是用POST方式进行提交。

**14.@RestController（如果控制层的类中使用它，则只能返回json或xml数据，不能返回jsp页面）**  
@RestController = @Controller + @ResponseBody

**15.@RequestMapping**  
用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

**16.@EnableAutoConfiguration**  
这个注解就是会根据你引入的依赖猜想你需要的配置，然后去自动配置。

**17.@EnableEurekaServer**  
在项目启动类上使用@EnableEurekaServer，可以将项目作为SpringCloud中的注册中心

**18.@EnableDiscoveryClient和@EnableEurekaClient**  
共同点就是：都是能够让注册中心能够发现，扫描到该服务。让微服务被注册中心发现然后注册，而不是当做注册中心。  
不同点：@EnableEurekaClient只适用于Eureka作为注册中心，@EnableDiscoveryClient 可以是其他注册中心。

**19.@EnableHystrix**  
启动熔断降级服务

**20.@SpringCloudApplication**  
包括@SpringBootApplication、@EnableDiscoveryClient、@EnableCircuitBreaker，分别是SpringBoot注解、注册服务中心Eureka注解、断路器注解。  
对于SpringCloud来说，这是每一微服务必须应有的三个注解，所以才推出了@SpringCloudApplication这一注解集合。

**21.@FeignClient（定义feign客户端）**  
用于微服务之间的调用

**22.@EnableScheduling和@Scheduled**  
定时任务在配置类上添加@EnableScheduling开启对定时任务的支持，在相应的方法上添加@Scheduled声明需要执行的定时任务。  
一个是开启定时任务，一个是声明要执行的定时任务。

**23.**  
（1）@GetMapping，处理get请求  
（2）@PostMapping，处理post请求  
（3）@PutMapping，处理put请求  
（4）@DeleteMapping，处理delete请求

**24.@Value**  
@Value(“$\{\}”)用来读取配置文件的属性值

**25.**  
（1）@Entity ：表明是一个实体类  
（2）@Table ：对应的数据表名  
（3）@Id ：主键  
（4）@GeneratedValue：主键生成策略  
（5）@Column : 映射表对应的字段名  
（6）@Basic ： 表示该属性是表字段的映射。 如果实体的字段上没有任何注解默认就是@Basic  
（7）@Transient : 表示该属性不是表字段的映射  
（8）@Lob : 将属性映射成支持的大对象类型 ，如Clob、Blob  
（9）@IdClass 联合主键，一般不用也不推荐用  
（10）@Temporal : 用来设置Date类型的属性映射到对应精度的字段  
（11）@Enumerated 直接映射枚举类型的字段

**26.@RequestParam**  
将请求参数绑定到你控制器的方法参数上（是springmvc中接收普通参数的注解）

**27.@Import**  
当一个类没有使用注解，没有交给Spring管理，这个时候又需要这个类的bean。就可以使用@Import来导入这个类创建bean

**28.@ImportResource（@ImportResource(“classpath:beans.xml”)）**  
用来导入xml文件使用

**29.@PathVariable**  
是spring3.0的一个新功能：接收请求路径中占位符的值。

**30.lombok相关注解**  
（1）@Data  
注解在类上, 为类（实体类）提供读写属性, 此外还提供了 equals()、hashCode()、toString() 方法。  
（2）@AllArgsConstructor  
注在类上，提供类的全参构造  
（3）@NoArgsConstructor  
注在类上，提供类的无参构造  
（4）@Setter @Getter  
可以为相应的属性自动生成Getter/Setter方法  
（5）@EqualsAndHashCode  
注在类上，提供对应的 equals 和 hashCode 方法  
（6）@Log4j/@Slf4j  
注在类上，提供对应的 Logger 对象，变量名为 log  
（7）@Builder  
为你的类生成相对略微复杂的构建器API  
（8）@ToString  
让lombok生成toString()方法的实现

**31.@EnableFeignClients**  
启用feign客户端

**32.**  
（1）@EnableTransactionManagement  
启动事务支持，等同于xml配置方式的 <tx:annotation-driven />  
（2）@Transactional  
在需要事务支持的实现类或者public方法上添加次注解实现事务回滚

**33.@Override**  
用于表示被标注的方法是一个重写方法。

**34.@PropertySource**  
加载指定的属性文件

**35.@Deprecated**  
若某类或某方法加上该注解之后，表示此方法或类不再建议使用，调用时也会出现删除线，但并不代表不能用，只是说，不推荐使用，因为还有更好的方法可以调用。

**36.@Slf4j**  
如果不想每次都写private final Logger logger = LoggerFactory.getLogger(XXX.class); 可以在类上使用注解@Slf4j

**37.@DependsOn**  
@DependsOn注解可以定义在类和方法上，意思是我这个组件要依赖于另一个组件，也就是说被依赖的组件会比该组件先注册到IOC容器中。

**38.@JsonProperty**  
主要用于实体类的属性上,作用可以简单的理解为在反序列化的时候给属性重命名

**39.@JsonInclude**  
后端返回给前端JSON格式的对象数据中，当对象的字段为NULL时，该字段也会写入JSON返回；而很多时候前端期望后端只返回对象中非null的字段数据。在Jackson框架中提供了 @JsonInclude 注解以实现该功能不返回null字段数据

**40.@PostConstruct**  
@PostConstruct该注解被用来修饰一个非静态的void（）方法。被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行，并且只会被服务器执行一次。PostConstruct在构造函数之后执行，init（）方法之前执行。

**41.@JsonIgnore**  
在json序列化时将pojo中的一些属性忽略掉，标记在属性或者方法上，返回的json数据即不包含该属性。

**42.shiro相关注解**  
（1）@RequiresAuthentication  
验证用户是否登录，等同于方法subject.isAuthenticated() 结果为true时。

**43. @NonNull**  
是JSR 305（缺陷检查框架）的注解，是告诉编译器这个域不可能为空，当代码检查有空值时会给出一个风险警告，目前这个注解只有IDEA支持。  
告诉编译器，参数非空。

**44.@Aspect**  
把当前类标识为一个切面供容器读取

**45.@Order**  
注解@Order或者接口Ordered的作用是定义Spring IOC容器中Bean的执行顺序的优先级，而不是定义Bean的加载顺序。值越小拥有越高的优先级，可为负数。

**46.@Scope**  
@Scope注解的目的是用来调节作用域  
（1）@Scope(“prototype”)//多实例，IOC容器启动创建的时候，并不会创建对象放在容器在容器当中，当你需要的时候，需要从容器当中取该对象的时候，就会创建。  
（2）@Scope(“singleton”)//单实例 IOC容器启动的时候就会调用方法创建对象，以后每次获取都是从容器当中拿同一个对象（map当中）。  
（3）@Scope(“request”)//同一个请求创建一个实例  
（4）@Scope(“session”)//同一个session创建一个实例

**47.@ControllerAdvice和@ExceptionHandler**  
@ControllerAdvice，是Spring3.2提供的新注解,它是一个Controller增强器,可对controller中被 @RequestMapping注解的方法加一些逻辑处理。最常用的就是异常处理

统一异常处理  
需要配合@ExceptionHandler使用。  
当将异常抛到controller时,可以对异常进行统一处理,规定返回的json格式或是跳转到一个错误页面

**48.spring中AOP相关注解**  
Advice(通知、切面)： 某个连接点所采用的处理逻辑，也就是向连接点注入的代码， AOP在特定的切入点上执行的增强处理。

1.@Before： 标识一个前置增强方法，相当于BeforeAdvice的功能.  
2.@After： final增强，不管是抛出异常或者正常退出都会执行.  
3.@AfterReturning： 后置增强，似于AfterReturningAdvice, 方法正常退出时执行.  
4.@AfterThrowing： 异常抛出增强，相当于ThrowsAdvice.  
5.@Around： 环绕增强，相当于MethodInterceptor.

JointPoint(连接点)：程序运行中的某个阶段点，比如方法的调用、异常的抛出等。

Pointcut(切入点)： JoinPoint的集合，是程序中需要注入Advice的位置的集合，指明Advice要在什么样的条件下才能被触发，在程序中主要体现为书写切入点表达式。

Advisor（增强）： 是PointCut和Advice的综合体，完整描述了一个advice将会在pointcut所定义的位置被触发。

@Aspect(切面): 通常是一个类的注解，里面可以定义切入点和通知

AOP Proxy：AOP框架创建的对象，代理就是目标对象的加强。Spring中的AOP代理可以使JDK动态代理，也可以是CGLIB代理，前者基于接口，后者基于子类。

**49.@Primary**  
在众多相同的Bean中，优先使用@Primary注解的Bean。

**50.@ConfigurationProperties**  
将配置文件(application.yaml)的每个属性的值，映射到这个组件中。  
告诉Springboot将本类中的所有属性和配置文件中的配置进行绑定；

**51.@Plugin**  
Plugin 注解提供了一种便捷的方法将一个类声明成 log4j2 的插件  
1.@ConverterKeys  
2.@PerformanceSensitive

**52.@JsonFormat**  
@JsonFormat注解是一个时间格式化注解，比如我们存储在mysql中的数据是date类型的，当我们读取出来封装在实体类中的时候，就会变成英文时间格式，而不是yyyy-MM-dd HH:mm:ss这样的中文时间，因此我们需要用到JsonFormat注解来格式化我们的时间。

**53.@Lazy**  
一般情况下，Spring容器在启动时会创建所有的Bean对象，使用@Lazy注解可以将Bean对象的创建延迟到第一次使用Bean的时候