Java SpringBoot 注解用法详解

快来打我* 2022-12-08 05:17 192阅读 0赞

***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。

@EnableAutoConfigruation实现的关键在于引入了AutoConfigurationImportSelector，其核心逻辑为selectImports方法，逻辑大致如下：

*  从配置文件META-INF/spring.factories加载所有可能用到的自动配置类；
 *  去重，并将exclude和excludeName属性携带的类排除；
 *  过滤，将满足条件（@Conditional）的自动配置类返回；

***3、@Configuration ***

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

***4、@ComponentScan ***

组件扫描。让Sping Boot扫描到Configuration类并把它加入到程序上下文。

@ComponentScan注解默认就会装配标识了@Controller,@Service,@Repository,@Component注解的类到spring容器中。

***5、@Repository***

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

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

***6、@Serivece***

一般用于修饰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></bean>，放在方法的上面，而不是类，意思是产生一个bean，并不交给spring管理。

***11、@AutoWired***

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

当加上（required = false）时，就算找不到bean也不报错。

***12、@Qualifier***

当有多个同一类型的Bean时，可以用@Qualifier("name")来指定，与@Autowored配合使用。

***13、@Resource(name="name",type="type")***

没有括号内容的话，默认byName。与@Autowored类似。

***14、@RequestMapping***

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

*** 15、@RequestParam***

用在方法的参数前面：

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

***16、@PathVariable***

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

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

***17、@Profiles***

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

@Configuration
    @Profile("prod")
    public class ProductionConfiguration{
        //do something;
    }

***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;
    }