SpringBoot常用注解

🚗 @Value

应用场景

比方说某个接口地址为www.baidu.com，以后可能会变成www.google.com。

因此，如果在代码中写死地址，以后地址变了，就需要改源代码，很烦。

这时候就需要把该地址写在配置文件中，需要改地址的时候直接改配置文件，就不用改源代码了。

使用方式

在配置文件(application.yaml)中定义该变量的值。
```
server:
  name: 123
```
提示
在yaml文件中，属性的冒号后面都有个空格，空格后面才是值。属性之间的父子层级关系靠缩进来表示。

在代码中声明类变量，并添加@Value注解

public class Demo {
    @Value("${server.name:www.baidu.com}")
    private String name;
}
//server.name后面的冒号，表示给它默认值，当配置文件中不存在server.name时，此时的name就为冒号后面的值:www.baidu.com

@Value注解在项目启动时读取配置文件中的信息，如果不存在，启动就会报错。通常报错：某个field找不到，导致某个Bean没有注入（Inject）

注意事项

如果明明代码都对，可就是获取不到值。可能原因如下：

yaml文件的名字不对，应该为application.yaml或application.yml。
yaml文件的位置不对，应该在resources目录下，并注意resources目录必须mark为项目的Resource Folders
属性名的大小写问题。
yaml代码书写格式问题。
如果读取配置中心的配置文件，如nacos配置中心，请检查请求的nacos配置中心的地址是否正确。nacos上的配置文件是否已经添加了该属性。

🚓 @ConfigurationProperties

应用场景

当配置文件中存在大量以相同字符开头的配置项的时候，为避免使用@Value注解一个一个地获取，代码不美观，书写繁琐。

可以以一个配置类的方式来获取这些配置项。

使用方式

附该注解的官方文档：Spring@ConfigurationProperties官方指导

使用之前需要引入以下依赖。复制下面代码粘贴到POM文件中，Reimport一下（快捷键Ctrl+Shift+O）即可导入。

提示

如果不引入，IDE会检测到错误：Spring Boot Configuration Annotation Processor not configured.

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

编写配置类
1. 起名为XXXConfig
2. 在该类上添加@Configuration注解，用@Component也行，两个是一样的，只不过@Configuration表明这是一个配置，@Component只表明这是个组件。
3. 添加@ConfigurationProperties注解，配置它的prefix为你写的配置前缀，这里假设你想读取的所有配置项都是以xxx开头的，需要保证XXXConfig类中的属性名与yaml配置文件中的配置项的名字一致。
```
xxx:
  address: https://baidu.com
  openId: 7107
  openKey: YXrsRE
  grantCode: ebd
```
```
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConfigurationProperties(prefix = "xxx")
@Data
public class XXXConfig {
    private String address;
    private String openId;
    private String openKey;
    private String grantCode;
}
```
1. 添加@Data注解
  添加@Data注解的目的是：添加get、set方法。使用@Data前提：POM中导入了lombok的依赖，IDE安装了lombok 的插件。
  你也可以不用添加@Data注解，直接添加get、set方法。

在需要的地方使用该配置类

    @Autowired
    private XXXConfig xxxConfig;
    
    public void test() {
        String address = xxxConfig.getAddress();
    }

嵌套使用

对于多层配置，可以嵌套读取配置，使用方法同上，很简单。

使用方法举例：

在ServerProperties类中添加一个新的属性private Host host；
属性名“host”与配置项中server.host的“host”保持一致。
在ServerProperties类中新增一个静态内部类Host。
为静态内部类Host添加get、set方法（可以用@Data注解）
完成

server:
  name: 123
  host:
    ip: 192.168.1.1
    port: 8080

@Configuration
@ConfigurationProperties(prefix="server")
@Data
public class ServerProperties {

    private String name;

    private Host host;
    
    @Data
    public static class Host {

        private String ip;

        private int port;

    }
}

提示

可以不断嵌套，只需要在静态内部类一层一层地添加新的静态内部类，并为每个类添加上get、set方法即可完成多层嵌套

特点

@ConfigurationProperties注解在项目开始启动的时候，如果配置类中有的属性，在配置文件中没有的，并不会报错。

@Value注解就不同，如果配置文件中没有，你又没给它默认值，项目启动的时候就会报错。通常报错：某个field找不到，导致某个Bean没有注入（Inject）

优化

因为spring-boot-configuration-processor这个jar文件只需要在编译时期起作用，编译完成后，运行时期就用不到它了。

因此，需要在打包前排除掉这个jar文件，减少打包后的整个项目jar文件的大小。

方法：在pom文件中添加以下代码，如果已经存在build或plugins等标签，需要在把其他部分复制粘贴到对应的标签下即可。

exclude意为排除。

<project>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.springframework.boot</groupId>
                            <artifactId>spring-boot-configuration-processor</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

🚚 @Transactional

应用场景

当一个方法需要进行事务控制的时候使用，该方法如果抛出RuntimeException（特别注意是RuntimeException），就会使这个方法内的所有的数据库操作回滚，也就是说一个@Transactional注解就是一个事务。

使用方式

标注在要启用事务控制的方法上。通常只需要标注上这个注解，就完全够用了，不需要其他配置，很简单。

注意事项

@Transactional必须放在public方法上，本质是Spring对该方法进行增强代理。也可以为非public方法设置该注解，需要配置，但推荐在public方法上使用。
该注解默认检测到RuntimeException才会认为该事务失败需要回滚，如果不配置的话，你抛出了非RuntimeException（普通的Exception，例如：throw new Exception("code error")），这个注解是不会生效的，事务是不会回滚的。可以指定它的rollback属性来控制能让他生效的异常类，如下面代码所示，此时只要是Exception及其子类都可以使注解生效，使事务生效。
```
@Transactional(rollbackFor = Exception.class)
```
如果需要在@Transactional标注的方法中try-catch，一定要记得catch之后，再手动抛出一个异常（Runtime Exception），不然该异常被你捕获了，@Transactional并不知道这个方法里抛出了异常，也就不会进行事务回滚。如果你只是想忽略某些异常，比方说一些不重要的异常，你可以通过刚说的try-catch的方式，避免该异常被@Transactional察觉到。
标注了@Transactional注解的方法中，调用了其他方法，那么其他方法中抛出的异常，也会被@Transactional察觉到，这一点不用担心。

🚗 @Value​

应用场景​

使用方式​

注意事项​

🚓 @ConfigurationProperties​

应用场景​

使用方式​

嵌套使用​

特点​

优化​

🚚 @Transactional​

应用场景​

使用方式​

注意事项​

🚗 @Value

应用场景

使用方式

注意事项

🚓 @ConfigurationProperties

应用场景

使用方式

嵌套使用

特点

优化

🚚 @Transactional

应用场景

使用方式

注意事项