springboot常用注解

1、@springbootapplication

这个注解是spring boot最核心的注解,用在 spring boot的主类上,标识这是一个 spring boot 应用,用来开启 spring boot 的各项能力。实际上这个注解是@configuration,@enableautoconfiguration,@componentscan三个注解的组合。由于这些注解一般都是一起使用,所以spring boot提供了一个统一的注解@springbootapplication。

2、@enableautoconfiguration

允许 spring boot 自动配置注解,开启这个注解之后,spring boot 就能根据当前类路径下的包或者类来配置 spring bean。
如:当前类路径下有 mybatis 这个 jar 包,mybatisautoconfiguration 注解就能根据相关参数来配置 mybatis 的各个 spring bean。
@enableautoconfiguration实现的关键在于引入了autoconfigurationimportselector,其核心逻辑为selectimports方法,逻辑大致如下:
 ● 从配置文件meta-inf/spring.factories加载所有可能用到的自动配置类;
 ● 去重,并将exclude和excludename属性携带的类排除;
 ● 过滤,将满足条件(@conditional)的自动配置类返回;

3、@configuration

用于定义配置类,指出该类是 bean 配置的信息源,相当于传统的xml配置文件,一般加在主类上。如果有些第三方库需要用到xml文件,建议仍然通过@configuration类作为项目的配置主类——可以使用@importresource注解加载xml配置文件。

4、@componentscan

组件扫描。让spring boot扫描到configuration类并把它加入到程序上下文。
@componentscan注解默认就会装配标识了@controller,@service,@repository,@component注解的类到spring容器中。

5、@repository

用于标注数据访问组件,即dao组件。
使用@repository注解可以确保dao或者repositories提供异常转译,这个注解修饰的dao或者repositories类会被componetscan发现并配置,同时也不需要为它们提供xml配置项。

6、@service

一般用于修饰service层的组件

7、@restcontroller

用于标注控制层组件(如struts中的action),表示这是个控制器bean,并且是将函数的返回值直 接填入http响应体中,是rest风格的控制器;它是@controller和@responsebody的合集。

8、@responsebody

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

9、@component

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

10、@bean

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

11、@autowired

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

12、@qualifier

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

13、@resource(name=”name”,type=”type”)

没有括号内内容的话,默认byname,通过名称找不到再去通过类型去查找。与@autowired干相似的事。

14、@requestmapping

requestmapping是一个用来处理请求地址映射的注解;提供路由信息,负责url到controller中的具体函数的映射,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。

15、@requestparam

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

@requestparam string a =request.getparameter("a")。

16、@pathvariable

路径变量。参数用到入参,与大括号里的名字一样要相同。如:

requestmapping("user/get/mac/{macaddress}")
 
public string getbyid(@pathvariable string id){
 
  ....
 
}

17、@profiles

spring profiles提供了一种隔离应用程序配置的方式,并让这些配置只能在特定的环境下生效。
任何@component或@configuration都能被@profile标记,从而限制加载它的时机。

@configuration
 
@profile("prod")
 
public class productionconfiguration {
 
    // ...
 
}

18、@configurationproperties

spring boot可使用注解的方式将自定义的properties文件映射到实体bean中,比如config.properties文件。

@data
 
@configurationproperties("rocketmq.consumer")
 
public class rocketmqconsumerproperties extends rocketmqproperties {
 
    private boolean enabled = true;
 
    private string consumergroup;
 
    private messagemodel messagemodel = messagemodel.clustering;
 
    private consumefromwhere consumefromwhere = consumefromwhere.consume_from_last_offset;
 
    private int consumethreadmin = 20;
 
    private int consumethreadmax = 64;
 
    private int consumeconcurrentlymaxspan = 2000;
 
    private int pullthresholdforqueue = 1000;
 
    private int pullinterval = 0;
 
    private int consumemessagebatchmaxsize = 1;
 
    private int pullbatchsize = 32;
 
}

19、@conditional

这是 spring 4.0 添加的新注解,用来标识一个 spring bean 或者 configuration 配置文件,当满足指定的条件才开启配置。

相关注解:( 

1)、@conditionalonbean
        组合 @conditional 注解,当容器中有指定的 bean 才开启配置。

2)、@conditionalonmissingbean
        组合 @conditional 注解,和 @conditionalonbean 注解相反,当容器中没有指定的 bean 才开启配置。

3)、@conditionalonclass
        组合 @conditional 注解,当容器中有指定的 class 才开启配置。

4)、@conditionalonmissingclass
        组合 @conditional 注解,和 @conditionalonmissingclass 注解相反,当容器中没有指定的 class 才开启配置。

5、@conditionalonwebapplication
        组合 @conditional 注解,当前项目类型是 web 项目才开启配置。

当前项目有以下 3 种类型。 

enum type {
 
    /**
     * any web application will match.
     */
    any,
 
    /**
     * only servlet-based web application will match.
     */
    servlet,
 
    /**
     * only reactive-based web application will match.
     */
    reactive
 
}

6)、@conditionalonnotwebapplication
        组合 @conditional 注解,和 @conditionalonwebapplication 注解相反,当前项目类型不是 web 项目才开启配置。

7)、@conditionalonproperty
        组合 @conditional 注解,当指定的属性有指定的值时才开启配置。

8)、@conditionalonexpression
        组合 @conditional 注解,当 spel 表达式为 true 时才开启配置。

9)、@conditionalonjava
        组合 @conditional 注解,当运行的 java jvm 在指定的版本范围时才开启配置。

10)、@conditionalonresource
        组合 @conditional 注解,当类路径下有指定的资源才开启配置。

11)、@conditionalonjndi
        组合 @conditional 注解,当指定的 jndi 存在时才开启配置。

12)、@conditionaloncloudplatform
        组合 @conditional 注解,当指定的云平台激活时才开启配置。

13)、@conditionalonsinglecandidate
        组合 @conditional 注解,当指定的 class 在容器中只有一个 bean,或者同时有多个但为首选时才开启配置。

20、@configurationproperties

用来加载额外的配置(如 .properties 文件),可用在 @configuration 注解类,或者 @bean 注解方法上面。

21、@enableconfigurationproperties

一般要配合 @configurationproperties 注解使用,用来开启对 @configurationproperties 注解配置 bean 的支持。

22、@autoconfigureafter

用在自动配置类上面,表示该自动配置类需要在另外指定的自动配置类配置完之后。

如 mybatis 的自动配置类,需要在数据源自动配置类之后。

@autoconfigureafter(datasourceautoconfiguration.class)
public class mybatisautoconfiguration {

23、@autoconfigurebefore

这个和 @autoconfigureafter 注解使用相反,表示该自动配置类需要在另外指定的自动配置类配置之前。

24、@import

这是 spring 3.0 添加的新注解,用来导入一个或者多个 @configuration 注解修饰的类,这在 spring boot 里面应用很多。

25、@importresource

这是 spring 3.0 添加的新注解,用来导入一个或者多个 spring 配置文件,这对 spring boot 兼容老项目非常有用,因为有些配置无法通过 java config 的形式来配置就只能用这个注解来导入。

到此这篇关于springboot中一些比较常用的注解总结的文章就介绍到这了,更多相关springboot注解内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com!