您的位置:首页 > 编程语言 > Java开发

SpringBoot常用注解(不断更新中)

2019-04-30 16:35 549 查看
版权声明:本文为博主原创文章,遵循 CC 4.0 by-sa 版权协议,转载请附上原文出处链接和本声明。 本文链接:https://blog.csdn.net/weixin_44096241/article/details/89711805

springBoot是现在非常流行的框架,而且springBoot的核心就是注解,所以先说一下springBoot的常用注解,

欢迎大家评论、补充以及纠错

SpringBoot常用注解

@SpringBootApplication:
这是SpringBoot最核心的注解,也是个组合注解。它的声明让spring boot自动给程序进行必要的配置,包含了(等同于后面三个注解配置)@ComponentScan、@Configuration和@EnableAutoConfiguration注解。通常用在主类上。

@EnableAutoConfiguration:
Spring Boot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的Spring应用。例如,如果你的classpath下存在HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库”。你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了你不想要的特定自动配置类,你可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置,一般加在主类上。

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

@RestController:
此注解是@Controller和@ResponseBody的合集,配置在controller层,就是告诉该控制层里面的方法都是以json的格式进行输出。

@Controller:
用于定义控制器类,在spring 项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层),一般这个注解在类中,通常方法需要配合注解@RequestMapping。

@ResponseBody:
表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据时使用,用于构建RESTful的api。在使用@RequestMapping后,返回值通常解析为跳转路径,加上@responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。比如异步获取json数据,加上@responsebody后,会直接返回json数据。该注解一般会配合@RequestMapping一起使用。

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

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

@SpringBootTest:
用于注解在测试类上的,告诉该类是用SpringBoot进行测试的。

@Configuration:
此注解并不是一个新的注解,他在spring3.0就有了,用于定义配置类,可替换xml配置文件,被@Configuration注解的类包含一个或者多个@Bean注解的方法,这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描,并用于构建bean定义,初始化Spring容器,一般加在主类上。
注意:@Configuration注解的配置类有几点要求,

  1. @Configuration不可以是final类型的
  2. @Configuration 不可以是匿名类,嵌套的Configuration必须是静态类

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

@Autowired:
自动导入依赖的bean。byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。

@Resource(name=“name”,type=“type”):
没有括号内内容的话,默认byName。与@Autowired相似。

@RequestMapping:提供路由信息,负责URL到Controller中的具体函数的映射。
该注解有六个属性:
params:指定request中必须包含某些参数值是,才让该方法处理。
headers:指定request中必须包含某些指定的header值,才能让该方法处理请求。
value:指定请求的实际地址,指定的地址可以是URI Template 模式
method:指定请求的method类型, GET、POST、PUT、DELETE等
consumes:指定处理请求的提交内容类型(Content-Type),如application/json,text/html;
produces:指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回

@Import:用来导入其他配置类。

@ImportResource:用来加载xml配置文件。

@Service:一般用于修饰service层的组件

@Repository:
使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。

@Value:注入Spring boot application.properties配置的属性的值。

@RequestParam:
用在方法的参数前面。例:

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

@PathVariable:
获取参数路径变量。参数与大括号里的名字一样要相同。例:

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

JPA常用注解

@Entity:@Table(name=”“):表明这是一个实体类。一般用于jpa这两个注解一般一块使用,但是如果表名和实体类名相同的话,@Table可以省略

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

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

@Column:如果字段名与列名相同,则可以省略。

@Id:表示该属性为主键。

@OneToOne、@OneToMany、@ManyToOne:
对应hibernate配置文件中的一对一,一对多,多对一。

@JsonIgnore:作用是json序列化时将Java bean中的一些属性忽略掉,序列化和反序列化都受影响。

@JoinColumn(name=”loginId”):一对一:本表中指向另一个表的外键。一对多:另一个表指向本表的外键。

@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名称,两个名称可以一致。

全局异常处理

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

@ExceptionHandler(Exception.class):
用在方法上面表示遇到这个异常就执行以下方法。

补充

@ApiOperation
@ApiOperation不是spring自带的注解是swagger里的 ,描述一个类的一个方法,或者说一个接口。com.wordnik.swagger.annotations.ApiOperation;属性说明:
@ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”;(个人认为:此注解写在controller层方法上边的)

内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: