SpringBoot❤SpringClould常用注解史诗级汇总

本文涉及的产品
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
传统型负载均衡 CLB,每月750个小时 15LCU
全局流量管理 GTM,标准版 1个月
简介: SpringBoot❤SpringClould常用注解史诗级汇总

什么是注解?


Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能


注解本质上继承 Annotation 接口,我们可以通过反射获取注解的相关信息,从而做些逻辑操作 springboot里⾯大量使用了注解,@Controller 、@RestController 、@Service、 @Autowire 等


一、SpringBoot注解


1.1.@SpringBootApplication


包含@Configuration、@EnableAutoConfiguration、@ComponentScan

通常用在主类上。


1.2.@Repository


用于标注数据访问组件,即DAO组件。


1.3.@Service


用于标注业务层组件。


1.4.@RestController


用于标注控制层组件(如struts中的action),包含@Controller@ResponseBody


1.5.@ResponseBody


表示该方法的返回结果直接写入HTTP response body中


一般在异步获取数据时使用,在使用@RequestMapping后,返回值通常解析为跳转路径,加上@responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。比如异步获取json数据,加上@responsebody后,会直接返回json数据。


1.6.@Component


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


1.7.@ComponentScan


组件扫描。个人理解相当于context:component-scan,如果扫描到有@Component @Controller @Service等这些注解的类,则把这些类注册为bean。


1.8.@Configuration


指出该类是 Bean 配置的信息源,相当于XML中的,一般加在主类上。


1.9.@Bean


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


1.10.@EnableAutoConfiguration


让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置,一般加在主类上。


1.11.@AutoWired


byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。


当加上(required=false)时,就算找不到bean也不报错。


1.12.@Qualifier


当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用


1.13.@Resource(name=“name”,type=“type”

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


1.14.@RequestMapping


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)类型中包含该指定类型才


返回


1.15.@RequestParam


用在方法的参数前面。


@RequestParam String a =request.getParameter("a")


1.16.@PathVariable


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

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

1.17.@Profiles


Spring Profiles提供了一种隔离应用程序配置的方式,并让这些配置只能在特定的环境下生效。


任何@Component或@Configuration都能被@Profile标记,从而限制加载它的时机

@Configuration
@Profile("prod")
public class ProductionConfiguration {
    // ...
}


1.18.@ConfigurationProperties


Spring Boot将尝试校验外部的配置,默认使用JSR-303(如果在classpath路径中)。


你可以轻松的为你的@ConfigurationProperties类添加JSR-303 javax.validation约束注解:

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNull
private InetAddress remoteAddress;
// ... getters and setters
}

全局异常处理


1.19.@ControllerAdvice


包含@Component。可以被扫描到。


统一处理异常。


1.20.@ExceptionHandler(Exception.class)


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


关于更多SpringBoot定时器、缓存、Jpa、事务注解可参照大佬此文:SpringBoot注解


二、SpringClould


2.1.汇总


@Controller 控制层,里面有多个连接


@Qualifier 如果一个接口有多个实现,那么注入时候加上唯一标示


@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定义其它组件(比如访问外部服务的组件)


@ModelAttribute 一般用于controller层,呗注解的方法会在所以mapping执行之前执行,并且可以绑定参数到Model model里面。


@Transactional (readOnly=true)注解式事务


@TransactionalEventListener用于配置事务的回调方法,可以在事务提交前、提交后、完成后以及回滚后几个阶段接受回调事件。


@Value(“${}”)可以注入properties里面的配置项


@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方法执行。指定回调方法


@Comfiguration 相当于传统的xml配置文件


@Import 导入其他配置类


@ImportResource用来 加载xml配置文件


@FeignClient注解中的fallbank属性指定回调类


@RestController 返回json字符串的数据,直接可以编写RESTFul的接口;


@CrossOrigin 可以处理跨域请求,让你能访问不是一个域的文件;


@ApiOperation 首先@ApiOperation注解不是Spring自带的,它是是swagger里的注解


@ApiOperation是用来构建Api文档的@ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”;


@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也就是服务鉴活策略等等


三、Lombok常用注解


c67dfcd0ae094834a6e8a2f8dfb43278.png


3.1.汇总


@Data 注解在类上;提供类所有属性的 getting 和 setting 方法,此外还提供了equals、canEqual、hashCode、toString 方法


@Setter :注解在属性上;为属性提供 setting 方法


@Setter :注解在属性上;为属性提供 getting 方法


@Log4j :注解在类上;为类提供一个 属性名为log 的 log4j 日志对象


@NoArgsConstructor :注解在类上;为类提供一个无参的构造方法


@AllArgsConstructor :注解在类上;为类提供一个全参的构造方法


@Cleanup : 可以关闭流


@Builder : 被注解的类加个构造者模式


@Synchronized : 加个同步锁


@SneakyThrows : 等同于try/catch 捕获异常


@NonNull : 如果给参数加个这个注解 参数为null会抛出空指针异常


@Value : 注解和@Data类似,区别在于它会把所有成员变量默认定义为private final修饰,并且不会生成set方法。



相关实践学习
SLB负载均衡实践
本场景通过使用阿里云负载均衡 SLB 以及对负载均衡 SLB 后端服务器 ECS 的权重进行修改,快速解决服务器响应速度慢的问题
负载均衡入门与产品使用指南
负载均衡(Server Load Balancer)是对多台云服务器进行流量分发的负载均衡服务,可以通过流量分发扩展应用系统对外的服务能力,通过消除单点故障提升应用系统的可用性。 本课程主要介绍负载均衡的相关技术以及阿里云负载均衡产品的使用方法。
目录
相关文章
|
2月前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
56 0
|
10天前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
136 73
|
3月前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
182 3
|
5天前
|
Java Spring 容器
【SpringFramework】Spring IoC-基于注解的实现
本文主要记录基于Spring注解实现IoC容器和DI相关知识。
39 21
|
10天前
|
存储 Java Spring
【Spring】获取Bean对象需要哪些注解
@Conntroller,@Service,@Repository,@Component,@Configuration,关于Bean对象的五个常用注解
|
10天前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
2月前
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
48 4
|
2月前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
81 4
SpringBoot必须掌握的常用注解!
|
2月前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
142 2
|
2月前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
59 2