java profiles_使用Profiles

Profile本身是Spring提供的功能，我们在使用条件装配中已经讲到了，Profile表示一个环境的概念，如开发、测试和生产这3个环境：

native

test

production

或者按git分支定义master、dev这些环境：

master

dev

在启动一个Spring应用程序的时候，可以传入一个或多个环境，例如：

-Dspring.profiles.active=test,master

大多数情况下，使用一个环境就足够了。

Spring Boot对Profiles的支持在于，可以在application.yml中为每个环境进行配置。下面是一个示例配置：

spring:

application:

name: ${APP_NAME:unnamed}

datasource:

url: jdbc:hsqldb:file:testdb

username: sa

password:

dirver-class-name: org.hsqldb.jdbc.JDBCDriver

hikari:

auto-commit: false

connection-timeout: 3000

validation-timeout: 3000

max-lifetime: 60000

maximum-pool-size: 20

minimum-idle: 1

pebble:

suffix:

cache: false

server:

port: ${APP_PORT:8080}

---

spring:

profiles: test

server:

port: 8000

---

spring:

profiles: production

server:

port: 80

pebble:

cache: true

注意到分隔符---，最前面的配置是默认配置，不需要指定Profile，后面的每段配置都必须以spring.profiles: xxx开头，表示一个Profile。上述配置默认使用8080端口，但是在test环境下，使用8000端口，在production环境下，使用80端口，并且启用Pebble的缓存。

如果我们不指定任何Profile，直接启动应用程序，那么Profile实际上就是default，可以从Spring Boot启动日志看出：

2020-06-13 11:20:58.141 INFO 73265 --- [ restartedMain] com.itranswarp.learnjava.Application : Starting Application on ... with PID 73265 ...

2020-06-13 11:20:58.144 INFO 73265 --- [ restartedMain] com.itranswarp.learnjava.Application : No active profile set, falling back to default profiles: default

要以test环境启动，可输入如下命令：

$ java -Dspring.profiles.active=test -jar springboot-profiles-1.0-SNAPSHOT.jar

. ____ _ __ _ _

/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \

( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \

\\/ ___)| |_)| | | | | || (_| | ) ) ) )

' |____| .__|_| |_|_| |_\__, | / / / /

=========|_|==============|___/=/_/_/_/

:: Spring Boot :: (v2.3.0.RELEASE)

2020-06-13 11:24:45.020 INFO 73987 --- [ main] com.itranswarp.learnjava.Application : Starting Application v1.0-SNAPSHOT on ... with PID 73987 ...

2020-06-13 11:24:45.022 INFO 73987 --- [ main] com.itranswarp.learnjava.Application : The following profiles are active: test

...

2020-06-13 11:24:47.533 INFO 73987 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8000 (http) with context path ''

...

从日志看到活动的Profile是test，Tomcat的监听端口是8000。

通过Profile可以实现一套代码在不同环境启用不同的配置和功能。假设我们需要一个存储服务，在本地开发时，直接使用文件存储即可，但是，在测试和生产环境，需要存储到云端如S3上，如何通过Profile实现该功能？

首先，我们要定义存储接口StorageService：

public interface StorageService {

// 根据URI打开InputStream:

InputStream openInputStream(String uri) throws IOException;

// 根据扩展名+InputStream保存并返回URI:

String store(String extName, InputStream input) throws IOException;

}

本地存储可通过LocalStorageService实现：

@Component

@Profile("default")

public class LocalStorageService implements StorageService {

@Value("${storage.local:/var/static}")

String localStorageRootDir;

final Logger logger = LoggerFactory.getLogger(getClass());

private File localStorageRoot;

@PostConstruct

public void init() {

logger.info("Intializing local storage with root dir: {}", this.localStorageRootDir);

this.localStorageRoot = new File(this.localStorageRootDir);

}

@Override

public InputStream openInputStream(String uri) throws IOException {

File targetFile = new File(this.localStorageRoot, uri);

return new BufferedInputStream(new FileInputStream(targetFile));

}

@Override

public String store(String extName, InputStream input) throws IOException {

String fileName = UUID.randomUUID().toString() + "." + extName;

File targetFile = new File(this.localStorageRoot, fileName);

try (OutputStream output = new BufferedOutputStream(new FileOutputStream(targetFile))) {

input.transferTo(output);

}

return fileName;

}

}

而云端存储可通过CloudStorageService实现：

@Component

@Profile("!default")

public class CloudStorageService implements StorageService {

@Value("${storage.cloud.bucket:}")

String bucket;

@Value("${storage.cloud.access-key:}")

String accessKey;

@Value("${storage.cloud.access-secret:}")

String accessSecret;

final Logger logger = LoggerFactory.getLogger(getClass());

@PostConstruct

public void init() {

// TODO:

logger.info("Initializing cloud storage...");

}

@Override

public InputStream openInputStream(String uri) throws IOException {

// TODO:

throw new IOException("File not found: " + uri);

}

@Override

public String store(String extName, InputStream input) throws IOException {

// TODO:

throw new IOException("Unable to access cloud storage.");

}

}

注意到LocalStorageService使用了条件装配@Profile("default")，即默认启用LocalStorageService，而CloudStorageService使用了条件装配@Profile("!default")，即非default环境时，自动启用CloudStorageService。这样，一套代码，就实现了不同环境启用不同的配置。

练习

小结

Spring Boot允许在一个配置文件中针对不同Profile进行配置；

Spring Boot在未指定Profile时默认为default。