springboot读取系统环境变量

springboot可以使用${}读取环境变量,利用这种特性,可以将数据库的url,user,password敏感信息进行隐藏.

即:向系统添加环境变量DB_HOST(数据库ip+端口),DB_USER(数据库用户),USER_PASSWORD(数据库密码).

在springboot配置文件中使用$D{B}_{H}OST,${DB_USER},${DB_PASSWORD}替换原有配置.

从而实现保护敏感信息,防止泄露数据库所在服务器以及数据库账号密码.

1.搭建一个基础项目

搭建一个基础项目用于验证是否能够正常连接数据库以及获取环境变量.

数据库脚本:

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user`  (
  `id` int(0) NOT NULL AUTO_INCREMENT,
  `username` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL,
  `age` int(0) NULL DEFAULT NULL,
  `hobby` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci ROW_FORMAT = Dynamic;

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES (1, 'zm', 18, '唱');
INSERT INTO `user` VALUES (2, 'cxk', 20, '跳');
INSERT INTO `user` VALUES (3, 'zwl', 21, 'rap');
INSERT INTO `user` VALUES (4, 'zyz', 22, '篮球');
INSERT INTO `user` VALUES (5, 'lhs', 27, '写代码');

SET FOREIGN_KEY_CHECKS = 1;

项目中使用的依赖信息:

springboot+mybatis+druid+druid.

mysql使用的是8.0

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.lhs</groupId>
    <artifactId>read_env</artifactId>
    <version>1.0</version>
    <name>read_env</name>
    <packaging>jar</packaging>
    <description>read_env</description>
    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-boot.version>2.6.13</spring-boot.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.2</version>
        </dependency>

        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.3.1</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.23</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${spring-boot.version}</version>

                <configuration>
                    <fork>true</fork>
                    <mainClass>com.lhs.read_env.ReadEnvApplication</mainClass>
                    <layout>JAR</layout>
                </configuration>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

application.yml

server:
  port: 9090

spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://${DB_HOST}/read_env?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8&nullCatalogMeansCurrent=true
    username: ${DB_USER}
    password: ${DB_PASSWORD}

mybatis-plus:
  type-aliases-package: com.lhs.read_env.domain
  mapper-locations: classpath*:mapper/*.xml
  global-config:
    db-config:
      id-type: AUTO

User实体类:

@TableName("user")
@Data
public class User {
    @TableId(type = IdType.AUTO)
    private Integer id;

    @TableField("username")
    private String name;

    private Integer age;

    private String hobby;
}

Controller:

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;

    @Value("${DB_HOST}")
    private String host;

    @Value("${DB_USER}")
    private String user;

    @Value("${DB_PASSWORD}")
    private String password;

    @RequestMapping("/getUser")
    public List<User> getUser(){
        return userService.list();
    }

    @RequestMapping("/getEnvInfo")
    public HashMap<String,String> getUserById(){
        HashMap<String, String> map = new HashMap<>();
        map.put("host",host);
        map.put("user",user);
        map.put("password",password);
        return map;
    }
}

Service以及Mapper使用的mybatis-plus的提供的默认实现,没什么业务代码,直接放在一起了

public interface UserMapper extends BaseMapper<User> {
}

public interface UserService extends IService<User> {
}

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}

2. 向系统添加环境变量

windows添加环境变量:

linux:

执行命令vim /etc/profile

DB_HOST=xxxx:xx
DB_USER=root
DB_PASSWORD=xxxx
export DB_HOST
export DB_USER
export DB_PASSWORD

保存后退出,执行source /etc/profile

注意:windows添加系统变量后,idea可能访问不到.可以关闭idea,再以管理员身份启动.

下面的是我自己遇到的一些问题,执行上面步骤没问题的可以不用看.

问题1:

1.使用阿里的初始化springboot,打成jar包,用java -jar启动提示找不到主类.

原因:pom.xml的spring-boot-maven-plugin插件这一块有个<skip>true</skip> 删掉

<plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${spring-boot.version}</version>

                <configuration>
                    <fork>true</fork>
                    <mainClass>com.lhs.read_env.ReadEnvApplication</mainClass>
                    <layout>JAR</layout>
                    <skip>true</skip>
                </configuration>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

2.windows/linux通过命令行的方式添加环境变量,虽然能直接访问到,但是可能存在重启就丢失的情况