SPRING Boot 注解大全

Spring Boot注解

.常用的注解

@SpringBootApplication 注解的使用

@SpringBootApplication：@SpringBootApplication=@ComponentScan+@Configuration+@EnableAutoConfiguration：约定优于配置

@EnableAutoConfiguration 启用 Spring 应用程序上下文的自动配置，试图猜测和配置您可能需要的bean。自动配置类通常采用基于你的classpath 和已经定义的 beans 对象进行应用。被 @EnableAutoConfiguration 注解的类所在的包有特定的意义，并且作为默认配置使用。通常推荐将 @EnableAutoConfiguration 配置在 root 包下，这样所有的子包、类都可以被查找到。

@ComponentScan：注解在类上，扫描标注了@Controller等注解的类，注册为bean 。@ComponentScan 为 @Configuration注解的类配置组件扫描指令。@ComponentScan 注解会自动扫描指定包下的全部标有 @Component注解的类，并注册成bean，当然包括 @Component下的子注解@Service、@Repository、@Controller。

@RequestMapping 注解的使用

（1）@RequestMapping　　和请求报文是做对应的　　　

a：value，指定请求的地址

　　b：method 请求方法类型 这个不写的话，自适应：get或者post

　　c：consumes 请求的提交内容类型

　　d：produces 指定返回的内容类型 仅当request请求头中的(Accept)类型中包含该指定类型才返回

　  e: params 指定request中必须包含某些参数值;使用 @RequestMapping 来处理请求参数,@RequestMapping 直接的 params 元素可以进一步帮助我们缩小请求映射的定位范围。使用 params 元素，你可以让多个处理方法处理到同一个URL 的请求, 而这些请求的参数是不一样的。

f：headers 指定request中必须包含指定的header值 ,使用 @RequestMapping 来处理消息头,@RequestMapping 注解提供了一个 header 元素来根据请求中的消息头内容缩小请求映射的范围。

g: name 指定映射的名称

@RequestMapping 快捷方式

（2.1）Spring 4.3 引入了方法级注解的变体，也被叫做 @RequestMapping 的组合注解。组合注解可以更好的表达被注解方法的语义。它们所扮演的角色就是针对 @RequestMapping 的封装，而且成了定义端点的标准方法。

例:

@RequestMapping(method = RequestMethod.GET)

@RequestMapping(method = RequestMethod.POST)

@RequestMapping(method = RequestMethod.PUT)

@RequestMapping(method = RequestMethod.DELETE)

当然也可以使用@GetMapping    @PostMapping  @PutMapping  @DeleteMapping 这与上面的是一样的效果

@RequestMapping 是 Spring Web 应用程序中最常用到的注解之一。这个注解会将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法上。

@RequestMapping 注解可以在控制器类的级别或其中的方法的级别上使用。在类的级别上的注解会将一个特定请求或者请求模式映射到一个控制器之上。之后你还可以另外添加方法级别的注解来进一步指定到处理方法的映射关系。

@RequestMapping 处理动态 URI

（4.1）@RequestMapping 注解可以同 @PathVaraible 注解一起使用，用来处理动态的 URI，URI 的值可以作为控制器中处理方法的参数。你也可以使用正则表达式来只处理可以匹配到正则表达式的动态 URI。

（4.2）@PathVariable 同 @RequestParam的运行方式不同。你使用 @PathVariable 是为了从 URI 里取到查询参数值。换言之，你使用 @RequestParam 是为了从 URI 模板中获取参数值。

@RequestParam 注解配合 @RequestMapping 一起使用，可以将请求的参数同处理方法的参数绑定在一起。

（5.1）@RequestParam 注解使用的时候可以有一个值，也可以没有值。这个值指定了需要被映射到处理方法参数的请求参数。例如：

@RequestParam(required = true) String username, //此注解用于规定请求参数中必须有username参数

（5.2）@RequestParam 注解的 required 这个参数定义了参数值是否是必须要传的。例如：

@RequestParam("page") Integer pageCurrent //此注解用于规定请求参数必须以page来传参

@springBootTest 注解进行单元测试

（1）@SpringBootTest 注解描述的类为一个单元测试类

  *  此类型的对象可以交给Spring容器管理.

@ResponseBody 注解的使用

@responseBody注解的作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据，

注意：在使用此注解之后不会再走试图处理器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。

@RequestMapping("/login")

　　@ResponseBody

　　public User login(User user){

　　　　return user;

　　}

　　User字段：userName pwd

　　那么在前台接收到的数据为：'{"userName":"xxx","pwd":"xxx"}'

　　效果等同于如下代码：

　　@RequestMapping("/login")

　　public void login(User user, HttpServletResponse response){

　　　　response.getWriter.write(JSONObject.fromObject(user).toString());

　　}

（2）@ResponseBody告诉spring mvc将返回值转换为JSON格式的字符串.

@Component 注解的使用

（1）@Component对类进行描述时表示此类 的对象由spring框架创建,并由spring管理.

@Scope 注解的使用

（1）@Scope用于告诉spring框架此类型的对象存储到什么作用域中(不同作用域会对应不同的存储方式).

对于非web项目,bean对象的作用域一般只有两个:

* 1) singleton 表示此类的实例在整个内存中只有一份(默认)

* 2) prototype 表示此类的实例每次请求都会创建一个新的对象.

* 3) request：表示在一次http请求内有效（只适用于web应用）

* 4）session：表示在一个用户会话内有效（只适用于web应用）

* 5）globalSession：表示在全局会话内有效（只适用于web应用）

注：在多数情况，我们只会使用singleton和prototype两种scope，如果未指定scope属性，默认为singleton

@PostConStruct与 @ProDestroy 注解的使用

（1）@PostConstruct 注解用于描述对象初始化方法.

          在对象对象初始化时,可以执行此方法 。

（2）@PreDestroy 注解用于描述对象销毁方法

            在对象销毁之前,可以让容器调用此方法,以完成资源释放操作。

@Mapper 与 @Repository 注解的使用

（1）@Mapper 注解用于修饰数据层接口

* 目的是告诉MyBatis框架,此接口的实现类由MyBatis框架创建,并且可以将实现类的对象交给

* Spring容器管理,Spring容器存储此类对象时,默认会将类名(首字母小写)作为key进行存储。

（2）@Repository 注解在类上，表示这是一个数据访问层bean

@Service  @Controller @Componen 注解的使用、

（1）@Service 注解在类上，表示这是一个业务层bean

（2）@Controller 注解在类上，表示这是一个控制层bean

（3）@Component： 注解在类上，表示通用bean，value不写默认就是类名首字母小写

@Autowired  @Qualifier @Resource 注解的使用

@Autowired 按类型注入.默认属性required= true;当不能确定 Spring 容器中一定拥有某个类的Bean 时， 可以在需要自动注入该类 Bean 的地方可以使用 @Autowired(required = false)， 这等于告诉Spring：在找不到匹配Bean时也不抛出BeanCreationException 异常。

@Autowired 和 @Qualifier 结合使用时，自动注入的策略就从 byType 转变byName 了。@Autowired可以对成员变量、方法以及构造函数进行注释，而 @Qualifier 的标注对象是成员变量、方法入参、构造函数入参。正是由于注释对象的不同，所以 Spring 不将 @Autowired 和 @Qualifier 统一成一个注释类。

@Resource 按名称装配

区别：

4.1）@Resource默认按照名称方式进行bean匹配，@Autowired默认按照类型方式进行bean匹配

4.2）@Resource(importjavax.annotation.Resource;)是J2EE的注解，@Autowired(importorg.springframework.beans.factory.annotation.Autowired;)是Spring的注解

@Configuration @Bean 注解的使用

@Configuration：注解在类上，表示这是一个IOC容器，相当于spring的配置文件，java配置的方式。 IOC容器的配置类一般与 @Bean 注解配合使用，用 @Configuration 注解类等价与 XML 中配置 beans，用@Bean 注解方法等价于 XML 中配置 bean。

@Bean： 注解在方法上，声明当前方法返回一个Bean

@RestController @RestControllerAdvice 与 @ExceptionHandler注解的使用

@RestController  是一个结合了 @ResponseBody和 @Controller 的注解

@ControllerAdvice  注解在类，注解描述的类为异常处理类，此类中可以定义多个异常处理方法   @RestControllerAdvice==@ControllerAdvice+@ResponseBody

@ExceptionHandler  用于描述异常处理方法，注解内部的异常类型，为方法能处理的异常类型。

例：

/@ControllerAdvice

//@ResponseBody

//注解优化

@RestControllerAdvice//==@ControllerAdvice+@ResponseBody

public class GlobalExceptionHandler {

/**

* @ExceptionHandler 用于描述异常处理方法，注解内部

* 的异常类型，为方法能处理的异常类型。

* @param e

* @return

*/

@ExceptionHandler(RuntimeException.class)

public JsonResult doHandleRuntimeException(

RuntimeException e) {

//输出异常栈中的信息

e.printStackTrace();

//封装异常信息

return new JsonResult(e);

}

}   

@ConfigurationProperties 注解的使用

@ConfigurationProperties 赋值，将注解转换成对象。给对象赋值。

@ConfigurationProperties  注解描述的类可以交给spring容器管理，并且可以从配置文件中读取配置信息然后赋值给对象属性（但属性需要提供set方法）

例：配置文件：application.yml

#PAGE

db:

  page:

    pageSize: 20

@Data

@ConfigurationProperties(prefix="db.page")

public class PageProperties{

private Integer pageSize=3;

}

@PathVariable 与 RequestParam注解的使用

@PathVariable 与 @RequestParam  两者的作用都是将request里的参数的值绑定到contorller里的方法参数里的，区别在于，URL写法不同。当请求参数username不存在时会有异常发生,可以通过设置属性required=false解决,例如:

@RequestParam(value="username",required=false)

使用@RequestParam 时，URL是这样的：http：//host:post/path?参数名=参数值

说明：假如对方法参数有更高的要求，例如这个参数必须有或者这个参数的值来自和方法参数不一样的请求参数对应的值，可以使用@RequestParam注解对参数进行修饰

public JsonResult doFindPageObjects(

//@RequestParam(required = true) String username, //此注解用于规定请求参数中必须有username参数

String username,

//@RequestParam("page") Integer pageCurrent //此注解用于规定请求参数必须以page来传参

Integer pageCurrent

) {

PageObject<SysLog> pageObject = sysLogService.findPageObjects(username, pageCurrent);

return new JsonResult(pageObject);

}

使用@PathVariable时，URL是这样的：http://host:port/path/参数值不写的时候也可以获取到参数值，但是必须名称对应。参数可以省略不写

说明：@PathVariable注解描述方法参数时表示这个参数的值可以取自url中某个变量的值 

例：/**优化返回UI界面:

* rest风格（软件架构风格）的url映射：

    *      其中：

* 1）{ }表示rest表达式，在这个表达式中用变量的形式表示url

* 2）@PathVariable注解描述方法参数时表示这个参数的值可以取自url中某个变量的值  */

@RequestMapping("{module}/{moduleUI}")

public String doModuleUI(@PathVariable String moduleUI) {

return "sys/"+moduleUI;

}

@Param 注解的使用

@Param  注解单一属性

dao层示例

@Mapper

public interface SysLogDao {

/**

* 基于条件查询总记录数

* @Param username 查询条件（例如查询哪个用户的日志信息）

* @return 总记录数（基于这个结果可以计算总页数）

* 说明：假如如下方法没有使用注解修饰，在基于名字进行查询

* 时候会出现There is no getter for property named

* username in class java.lang.String

*/

int getRowCount(@Param("username")String username);

xml映射对应示例

<!-- sql元素用于对共性进行提取 -->

<sql id="queryWhereId">

from sys_logs

<where>

<if test="username!=null and username!=''">

username like concat("%",#{username},"%")

</if>

</where>

</sql>

<!--基于条件统计记录总数 -->

<select id="getRowCount" resultType="int">

select count(*)

<include refid="queryWhereId" />

</select>

注意：采用#{}的方式把@Param注解括号内的参数进行引用（括号内参数对应的是形参如 username对应的是username..........）；

@Param 注解javaBean对象

dao层示例

List<SysLog> findPageObjects(@Param("username")String username,

@Param("startIndex")Integer startIndex,

@Param("pageSize")Integer pageSize);

xml映射对应示例

<!-- sql元素用于对共性进行提取 -->

<sql id="queryWhereId">

from sys_logs

<where>

<if test="username!=null and username!=''">

username like concat("%",#{username},"%")

</if>

</where>

</sql>

<select id="findPageObjects"

resultType="com.cy.pj.sys.entity.SysLog">

select *

<include refid="queryWhereId" />

order by createdTime desc

limit #{startIndex},#{pageSize}

</select>

注：在不使用@Param注解的时候，函数的参数只能为一个，并且在查询语句取值时只能用#{}，且其所属的类必须为Javabean,而使用@Param注解则可以使用多个参数，在查询语句中使用时可以使用#{}或者${}

@cachenamespaceRef 与 @EnablCaching 注解的使用

@CacheNamespaceRef 注解表示此接口中的查询操作要使用二级缓存，其二级缓存的配置参考name属性对应的命名空间配置

Dao层示例：

@Mapper

//@CacheNamespaceRef(SysMenuDao.class)

@CacheNamespaceRef(name="com.cy.pj.sys.dao.SysMenuDao")

public interface SysMenuDao {

}

xml映射对应示例

<mapper namespace="com.cy.pj.sys.dao.SysMenuDao">

<!-- 使用mybatis中二级缓存 eviction:表示算法，配置创建了一个FIFO缓存-->

（ LRU –最近最少使用：删除最长时间未使用的对象。

FIFO –先进先出：按照对象进入缓存的顺序删除对象。

  SOFT –软引用：根据垃圾收集器状态和软引用规则删除对象。

WEAK –弱引用：根据垃圾回收器状态和弱引用规则更主动地删除对象），

<!--flushInterval：表示该缓存每60秒刷新一次， size：表示最多存储512个对结果对象或列表的引用， readOnly：表示返回的对象被视为只读对象 -->

<cache

eviction="FIFO" 

flushInterval="60000" 

size="512"

readOnly="true" />

（2）@EnablCaching 注解是spring framework中的注解驱动的缓存管理功能。自spring版本3.1起加入了该注解。如果你使用了这个注解，那么你就不需要在XML文件中配置cache manager了。

@Value @Profile  @suppressWarnings  @Modifying与 @Qurey 注解的使用

@Value：注解在变量上，从配置文件中读取。

例如：@Value(value = “#{message}”)

@Profile：注解在方法类上在不同情况下选择实例化不同的Bean特定环境下生效！

@suppresswarnings 抑制警告

@Modifying 如果是增，改，删加上此注解

1：方法的返回值应该是int，表示更新语句所影响的行数。

2：在调用的地方必须加事务，没有事务不能正常执行。@Transactional 事务注解

@Query自定义查询语句JPQL

2. Lombok 常用注解分析：

（1）@Setter 注解在类或字段

注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。

（2）@Getter 注解在类或字段

注解在类时为所有字段生成getter方法，注解在字段上时只为该字段生成getter方法。

（3）@ToString 注解在类

添加toString方法。

（4）@EqualsAndHashCode 注解在类，

生成hashCode和equals方法。

（5）@NoArgsConstructor 注解在类，

生成无参的构造方法。

（6）@RequiredArgsConstructor 注解在类，

为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。

（7）@AllArgsConstructor 注解在类，

生成包含类中所有字段的构造方法。

（8）@Data 注解在类，

生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

（9）@Slf4j 注解在类，

生成log变量，严格意义来说是常量。private static final Logger log = LoggerFactory.getLogger(UserController.class);

JPA注解：

注：JPA的注解要么全部都在get上要么全都是属性上不能混用

（1） @Column：通过@Column注解设置，包含的设置如下

name：数据库表字段名

unique：是否唯一

nullable：是否可以为空

Length:长度

inserttable：是否可以插入

updateable：是否可以更新

columnDefinition: 定义建表时创建此列的DDL

secondaryTable: 从表名。如果此列不建在主表上（默认建在主表），该属性定义该列所在从表的名字。

@Column(name = "user_code", nullable = false, length=32)//设置属性userCode对应的字段为user_code，长度为32，非空

private String userCode;

@Column(name = "user_wages", nullable = true, precision=12,scale=2)//设置属性wages对应的字段为user_wages，12位数字可保留两位小数，可以为空

private double wages;

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

@Temporal 注解

@Temporal(TemporalType.DATE)//设置为时间类型

private Date joinDate;

@Transient：表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic。@Basic(fetch=FetchType.LAZY)：标记可以指定实体属性的加载方式

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

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

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

@GeneratedValue 用于标注主键的生成策略，通过 strategy 属性指定。

（8.1）默认情况下，JPA 自动选择一个最适合底层数据库的主键生成策略：SqlServer 对应 identity，MySQL 对应 auto increment。

（8.2）在 javax.persistence.GenerationType 中定义了以下几种可供选择的策略：

（2.1）IDENTITY：采用数据库 ID自增长的方式来自增主键字段，Oracle 不支持这种方式；

（2.2）AUTO： JPA自动选择合适的策略，是默认选项；

（2.3）SEQUENCE：通过序列产生主键，通过@SequenceGenerator注解指定序列名，MySql 不支持这种方式

（2.4）TABLE：通过表产生主键，框架借由表模拟序列产生主键，使用该策略可以使应用更易于数据库移植。       

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 158,560评论 4赞 361
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,104评论 1赞 291
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 108,297评论 0赞 243
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 43,869评论 0赞 204
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,275评论 3赞 287
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,563评论 1赞 216
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,833评论 2赞 312
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,543评论 0赞 197
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,245评论 1赞 241
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,512评论 2赞 244
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,011评论 1赞 258
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,359评论 2赞 253
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,006评论 3赞 235
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,062评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,825评论 0赞 194
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,590评论 2赞 273
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,501评论 2赞 268

推荐阅读更多精彩内容