SpringBoot 注解说明

我就是我 2022-02-15 17:29 542阅读 0赞

**1， @Configuration 注解:**

>      加在类上的注解，将某个类A定义成配置类，这样SpringBoot在启动main方法后就会自动实例化一个类A的对象。常与**@PropertySource**一起使用。
> 
> ![2019042510190788.png][]
> 
>  
> 
> ![20190425101851475.png][]

**2，****@PropertySource 注解：**

> **     **其注解有 value 属性，数组格式，主要读取配置文件的路径，常与@Configuration或者@ConfigurationProperties一起使用。
> 
> ![20190424193851259.png][]

**3，@Value 注解：**

> **   **  常用在属性上，以 **  $**\{\}  形式读取 application.yml（application.properties）文件中的定义值
> 
> ![2019042419440485.png][]
> 
> ![20190424194338454.png][]
> 
>    也可以直接 @Value（"XXXX"） 对属性进行赋值。
> 
> ![20190424194431760.png][]

**4，****@ConfigurationProperties 注解：**

> 定义在类上的注解，默认读取application.yml（application.properties）中的值，通过prefix定义前缀值，也常与@PropertySource一起使用。类中的属性名要与读取文件中的相同，并且要加上@Component注解（或者通过@Bean方式注入到Spring容器中）：
> 
> ![20190425095836387.png][]
> 
> ![20190425100815696.png][]
> 
>  
> 
> （如果发现@ConfigurationPropertie不生效，有可能是项目的目录结构问题，你可以通过@EnableConfigurationProperties(WeChatConfig.class)来明确指定需要用哪个实体类来装载配置信息，如图：
> 
> ![20190425100549151.png][]
> 
> ）
> 
>  
> 
>

**5，@SpringBootApplication(scanBasePackages = \{“com.qiu”\}, exclude = \{\})**

> 包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中@ComponentScan让spring Boot扫描到Configuration类并把它加入到程序上下文。scanBasePackages：设置ComponentScan扫描包路径

**6，@ComponentScan：**

> 组件扫描，可自动发现和装配一些Bean。@ComponentScan告诉Spring 哪个packages 的用注解标识的类 会被spring自动扫描并且装入bean容器。   
> 例如，如果你有个类用@Controller注解标识了，那么，如果不加上@ComponentScan，自动扫描该controller，那么该Controller就不会被spring扫描到，更不会装入spring容器中，因此你配置的这个Controller也没有意义。

**7，@EnableAutoConfiguration：**

> 自动配置。@EnableAutoConfiguration和@Configuration是成对出现，@EnableAutoConfiguration负责去扫描带有@Configuration的类。   
> 由于springboot相当于一个CI，可以持续集成，所有@EnableAutoConfiguration相当于对集成进来的模块进行初始化的工作。   
> 会去扫描pom文件中所依赖的jar包，依赖了哪个jar包就对这个jar进行初始化。

**8，@MapperScan(“cn.qiu.mapper”)：**

> mybatis框架中的dao扫描

**9，@ServletComponentScan(basePackages = \{ “com.panger(包名)” \})：**

> 扫描工程中的Servlet、Filter、Listener（带注解的）

**10，@RunWith(SpringJUnit4ClassRunner.class)：**

> SpringJUnit支持，由此引入Spring-Test框架支持！

**11，@SpringApplicationConfiguration(classes = App.class)：**

> 指定我们SpringBoot工程的Application启动类（App是项目的启动类）

**12，@WebAppConfiguration：**

> 由于是Web项目，Junit需要模拟ServletContext，因此我们需要给我们的测试类加上@WebAppConfiguration。

**13，@Resource和@Autowired：**

> @Resource和@Autowired都是做bean的注入时使用，其实@Resource并不是Spring的注解，它的包是javax.annotation.Resource，需要导入，但是Spring支持该注解的注入。
> 
> **1、共同点**
> 
> 两者都可以写在字段和setter方法上。两者如果都写在字段上，那么就不需要再写setter方法。
> 
> **2、不同点**
> 
> （1）@Autowired
> 
> @Autowired为Spring提供的注解，需要导入包org.springframework.beans.factory.annotation.Autowired;只按照byType注入。
> 
>     public class TestServiceImpl {
>         // 下面两种@Autowired只要使用一种即可
>         @Autowired
>         private UserDao userDao; // 用于字段上
>         
>         @Autowired
>         public void setUserDao(UserDao userDao) { // 用于属性的方法上
>             this.userDao = userDao;
>         }
>     }
> 
> @Autowired注解是按照类型（byType）装配依赖对象，默认情况下它要求依赖对象必须存在，如果允许null值，可以设置它的required属性为false。如果我们想使用按照名称（byName）来装配，可以结合@Qualifier注解一起使用。如下：
> 
>     public class TestServiceImpl {
>         @Autowired
>         @Qualifier("userDao")
>         private UserDao userDao; 
>     }
> 
>  
> 
> （2）@Resource
> 
> @Resource默认按照ByName自动注入，由J2EE提供，需要导入包javax.annotation.Resource。@Resource有两个重要的属性：name和type，而Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。所以，如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不制定name也不制定type属性，这时将通过反射机制使用byName自动注入策略。
> 
>     public class TestServiceImpl {
>         // 下面两种@Resource只要使用一种即可
>         @Resource(name="userDao")
>         private UserDao userDao; // 用于字段上
>         
>         @Resource(name="userDao")
>         public void setUserDao(UserDao userDao) { // 用于属性的setter方法上
>             this.userDao = userDao;
>         }
>     }
> 
>  
> 
> 注：最好是将@Resource放在setter方法上，因为这样更符合面向对象的思想，通过set、get去操作属性，而不是直接去操作属性。
> 
> @Resource装配顺序：
> 
> ①如果同时指定了name和type，则从Spring上下文中找到唯一匹配的bean进行装配，找不到则抛出异常。
> 
> ②如果指定了name，则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常。
> 
> ③如果指定了type，则从上下文中找到类似匹配的唯一bean进行装配，找不到或是找到多个，都会抛出异常。
> 
> ④如果既没有指定name，又没有指定type，则自动按照byName方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配。
> 
> @Resource的作用相当于@Autowired，只不过@Autowired按照byType自动注入。

**14、@ModelAttribute和 @SessionAttributes：**

> **@ModelAttribute **代表的是：该Controller的所有方法在调用前，先执行此@ModelAttribute方法，可用于注解和方法参数中，可以把这个@ModelAttribute特性，应用在BaseController当中，所有的Controller继承BaseController，即可实现在调用Controller时，先执行@ModelAttribute方法。
> 
> ![20190425161508244.png][]
> 
> ![20190425161525354.png][]
> 
> ** 当请求 127.0.0.1:8080/test 接口时，会先执行 BaseController中被@ModelAttribute 定义的方法 consoleLog()。**
> 
>  
> 
>  @SessionAttributes即将值放到session作用域中，写在class上面。
> 
> 相关连接：  [https://www.jianshu.com/p/bf2e67abe8f7][https_www.jianshu.com_p_bf2e67abe8f7]

**15，@EnableTransactionManagement ：**

> 在SpringBoot 的 启动类上加入此注解，开启事务支持后，然后在访问数据库的Service方法上添加注解 @Transactional 便可。
> 
>     @SpringBootApplication
>     @EnableTransactionManagement //开启事务管理
>     public class WxVideoApplication {
>     
>         public static void main(String[] args) {
>             SpringApplication.run(WxVideoApplication.class, args);
>         }
>     
>     }
> 
>  
> 
> Service 层：
> 
>     @Transactional(propagation = Propagation.REQUIRED)
>         public void save(User user){
>             
>             // TODO 代码略...
>             
>         }
> 
>

部分文章链接：  [http://www.cnblogs.com/leskang/p/5445698.html][http_www.cnblogs.com_leskang_p_5445698.html]

[2019042510190788.png]: /images/20220215/30a777db099c48a0910c21f2a5ed28bb.png
[20190425101851475.png]: /images/20220215/4e83e65f11b14953ab9011f2f6c0cdd3.png
[20190424193851259.png]: /images/20220215/c3d6ca3e73bb4dc3b8dac2fb4bc04a3a.png
[2019042419440485.png]: /images/20220215/69344c5fb25e4fc8b57434f2388435cf.png
[20190424194338454.png]: /images/20220215/ceaf9ad9ff5d4324b1ff239184fc4236.png
[20190424194431760.png]: /images/20220215/aff210c84c934704861978eaa1ca2b4c.png
[20190425095836387.png]: /images/20220215/ba8b486330264fcbbf5c601aa5535eb9.png
[20190425100815696.png]: /images/20220215/e12ac0b5f3584950aef5128fe065b7ec.png
[20190425100549151.png]: /images/20220215/cbe0e02625e34a2889f203fed55064c1.png
[20190425161508244.png]: /images/20220215/59c107d598e845f787d428749fe3a9ee.png
[20190425161525354.png]: /images/20220215/3bc06d8f892c4d71bf17021944fda45f.png
[https_www.jianshu.com_p_bf2e67abe8f7]: https://www.jianshu.com/p/bf2e67abe8f7
[http_www.cnblogs.com_leskang_p_5445698.html]: http://www.cnblogs.com/leskang/p/5445698.html