Spring 技巧 - @Value 复用

zhaojun

2023 年 10 月 12 日

701 次浏览

暂无评论

1388字数

默认分类

平时我们想将 Spring Boot 配置文件中的值注入到变量中，我们可以使用 @Value 注解，如：

```yaml
server:
  port: 8080
```

```java
@Value("${server.port}")
private Integer port;
```

但是，如果代码中有多个地方想使用的话，就需要在多个地方都使用 @Value 注解，这样就会显得很麻烦，而且如果配置文件中的值发生了变化，那么我们就需要在多个地方都修改，容易出错。

为了解决这个问题，我们可以抽取一个自定义注解，如：

```java
import org.springframework.beans.factory.annotation.Value;

import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Value("${server.port}")
public @interface ServerPort {
}
```

然后在需要使用的地方使用该注解，如：

```java
import org.springframework.stereotype.Component;

@Component
public class TestService {

@ServerPort
    private Integer port;

public void test() {
        System.out.println(port);
    }
}
```

这样使用自定义注解和 @Value 注解的效果是一样的，但是可以减少代码量，而且如果配置文件中的值发生了变化，我们只需要修改自定义注解即可。

> 不过这只适用于使用 @Value 注解的场景，更推荐的做法是将配置文件中的值注入到一个对象中，然后在需要使用的地方注入该对象，如：

```yaml
server:
  port: 8080
  address: 127.0.0.1
```

```java
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

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

private Integer port;

private String address;
    
    // getter and setter
}
```

最后修改：2024 年 02 月 20 日

如果觉得我的文章对你有用，请我喝杯咖啡吧。

Spring 技巧 - @Value 复用

zhaojun • 2023 年 10 月 12 日

Spring 技巧 - @Value 复用

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

谈裸辞和开源的体会

剑指 Offer 04. 二维数组中的查找

宝塔 nginx 增加编译模块

通过 Github Actions 自动构建 ZFile 镜像并推送到 Docker Hub

优化 Java 项目 Docker 镜像内存占用从 500 M 到 100M

修复 docker buildx 编译后，manifest 包含 unknown 的问题

代码命名之 Spring

Spring MVC/Boot 统一异常处理最佳实践

浅谈如何在大陆服务器加速访问 github 和 k8s.gcr.io 等资源 - sniproxy

ZFile 4.0.0 Bate 版本宝塔部署教程

Spring 技巧 - @Value 复用

发表评论 取消回复 使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

Spring 技巧 - @Value 复用

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款