SpringBoot中必须掌握的45个注解

软件 作者:程序员狗哥 2022-01-06 20:21:19 阅读:878

来自:CSDN,作者:Wakfu

链接:https://blog.csdn.net/sbuiwqvb123/article/details/70331956

1.SpringBoot/spring


@SpringBootApplication:

包含@Configuration、@EnableAutoConfiguration、@ComponentScan通常用在主类上;


@Repository:

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


@Service:

用于标注业务层组件;


@RestController:

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


@Controller:

用于标注是控制层组件,需要返回页面时请用@Controller而不是@RestController;


@Component:

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


@ResponseBody:

表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据时使用,在使用@RequestMapping后,返回值通常解析为跳转路径,

加上@responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中;比如异步获取json数据,加上@responsebody后,会直接返回json数据;


@RequestBody:

参数前加上这个注解之后,认为该参数必填。表示接受json字符串转为对象 List等;


@ComponentScan:

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


@Configuration:

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


@Bean:

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


@EnableAutoConfiguration:

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


@AutoWired:

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

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


@Qualifier:

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


@Resource(name=”name”,type=”type”):

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


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


@GetMapping、@PostMapping等:

相当于@RequestMapping(value=”/”,method=RequestMethod.Get\Post\Put\Delete等) 。是个组合注解;


@RequestParam:

用在方法的参数前面。相当于 request.getParameter();


@PathVariable:

路径变量。如 RequestMapping(“user/get/mac/{macAddress}”) ;

public String getByMacAddress(
@PathVariable(“macAddress”)
 String macAddress)
{
//do something;
}


参数与大括号里的名字相同的话,注解后括号里的内容可以不填。


2.Jpa


@Entity:

@Table(name=”“):

表明这是一个实体类。一般用于jpa ,这两个注解一般一块使用,但是如果表名和实体类名相同的话,@Table可以省略;


@MappedSuperClass:

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


@NoRepositoryBean:

一般用作父类的repository,有这个注解,spring不会去实例化该repository;


@Column:

如果字段名与列名相同,则可以省略;


@Id:

表示该属性为主键;


@GeneratedValue(strategy=GenerationType.SEQUENCE,generator = “repair_seq”):

表示主键生成策略是sequence(可以为Auto、IDENTITY、native等,Auto表示可在多个数据库间切换),指定sequence的名字是repair_seq;


@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1):

name为sequence的名称,以便使用,sequenceName为数据库的sequence名称,两个名称可以一致;


@Transient:

表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性. 

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


@Basic(fetch=FetchType.LAZY):

标记可以指定实体属性的加载方式;


@JsonIgnore:

作用是json序列化时将java bean中的一些属性忽略掉,序列化和反序列化都受影响;


@JoinColumn(name=”loginId”):

一对一:本表中指向另一个表的外键。

一对多:另一个表指向本表的外键。


@OneToOne

@OneToMany

@ManyToOne:

对应Hibernate配置文件中的一对一,一对多,多对一。


3.全局异常处理


@ControllerAdvice:

包含@Component。可以被扫描到。统一处理异常;


@ExceptionHandler(Exception.class):

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


4.springcloud


@EnableEurekaServer:

用在springboot启动类上,表示这是一个eureka服务注册中心;


@EnableDiscoveryClient:

用在springboot启动类上,表示这是一个服务,可以被注册中心找到;


@LoadBalanced:

开启负载均衡能力;


@EnableCircuitBreaker:

用在启动类上,开启断路器功能;


@HystrixCommand(fallbackMethod=”backMethod”):

用在方法上,fallbackMethod指定断路回调方法;


@EnableConfigServer:

用在启动类上,表示这是一个配置中心,开启Config Server;


@EnableZuulProxy:

开启zuul路由,用在启动类上;


@SpringCloudApplication:

包含

@SpringBootApplication  

@EnableDiscovertyClient

@EnableCircuitBreaker

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

重磅!程序员交流群(无广告)已成立

在群里和大家分享一些程序员开发相关的知识,包括部分自己的实战项目,基础入门知识,spring,jvm,mysql等等。也会免费分享一些Java视频教程、电子资料、Mysql资料、Kubernetes及最新Java面试资料

同时为了帮助到其他技术栈 小伙伴,我也准备了一些Python,前端,Linux,C语言等其他技术资料!

有兴趣入群的同学,可长按扫描下方二维码添加微信

一定要备注:Java,可更快被通过且邀请进群

关注公众号:拾黑(shiheibook)了解更多

[广告]赞助链接:

四季很好,只要有你,文娱排行榜:http://www.yaopaiming.com/
让资讯触达的更精准有趣:https://www.0xu.cn/

图库
关注网络尖刀微信公众号
随时掌握互联网精彩
赞助链接