为基于spring-boot的应用添加根据运行时操做系统环境来提示用户选择active profile的功能

时间 2019-11-16

标签基于 spring boot 应用添加根据运行时系统环境提示用户选择 active profile 功能栏目 Spring 繁體版

原文原文链接

spring-boot有一个根据JVM变量-Dspring.profiles.active来设置运行时的active profile的功能，可是有些时候咱们也许会不当心忘记设置这个变量，这样在生产环境中会带来必定的困扰，因此我想了一个办法，来给忘记设置-Dspring.profiles.active的程序员一次“secend chance”。java

先来说一下思路：程序员

step0 约定好profiles的命名，“development”表明开发环境(也能够将默认的profile设为开发环境)，“production”表明生产环境
step1 判断是否设置了-Dspring.profiles.active，若是已经设置，直接跳转step3
step2 判断当前操做系统环境，若是不是Linux环境则认定为开发环境，自动倒计时激活开发的profile；若是是Linux环境则认定为生产环境，输出选择profile的控制台信息，并等待用户控制台输入进行选择，并依据用户选择来激活profile
step3 SpringApplication.run()

代码以下：spring

spring-boot配置文件(使用了默认profile做为开发环境)：apache

spring:
  application:
    name: comchangyoueurekaserver #注意命名要符合RFC 2396，不然会影响服务发现 详见https://stackoverflow.com/questions/37062828/spring-cloud-brixton-rc2-eureka-feign-or-rest-template-configuration-not-wor

server:
  port: 8001

eureka:
  instance:
    hostname: localhost
  client:
    registerWithEureka: false
    fetchRegistry: false
    serviceUrl:
      defaultZone: http://${eureka.instance.hostname}:${server.port}

---
spring:
  profiles: production
  application:
    name: comchangyoueurekaserver

server:
  port: 8001

eureka:
  instance:
    hostname: localhost
  client:
    registerWithEureka: false
    fetchRegistry: false
    serviceUrl:
      defaultZone: http://${eureka.instance.hostname}:${server.port}
复制代码

BootStarter封装了step1-step3的逻辑：tomcat

import org.apache.commons.lang3.StringUtils;

import java.util.Scanner;
import java.util.Timer;
import java.util.TimerTask;
import java.util.regex.Pattern;

public class BootStarter {

    //用于后续Spring Boot操做的回调
    public interface Callback {
        void bootRun();
    }

    private boolean enableAutomaticallyStart = true;
    private int automaticallyStartDelay = 10;

    public boolean isEnableAutomaticallyStart() {
        return enableAutomaticallyStart;
    }

    public void setEnableAutomaticallyStart(boolean enableAutomaticallyStart) {
        this.enableAutomaticallyStart = enableAutomaticallyStart;
    }

    public int getAutomaticallyStartDelay() {
        return automaticallyStartDelay;
    }

    public void setAutomaticallyStartDelay(int automaticallyStartDelay) {
        this.automaticallyStartDelay = automaticallyStartDelay;
    }

    public void startup(boolean enableAutomaticallyStart, int automaticallyStartDelay, Callback callback) {
        if (StringUtils.isBlank(System.getProperty("spring.profiles.active"))) { //若是没有经过参数spring.profiles.active设置active profile则让用户在控制台本身选择
            System.out.println("***Please choose active profile:***\n\tp: production\n\td: development");

            final boolean[] started = {false};
            Timer timer = new Timer();
            if (enableAutomaticallyStart && System.getProperty("os.name").lastIndexOf("Linux") == -1) { //若是当前操做系统环境为非Linux环境(通常为开发环境)则automaticallyStartDelay秒后自动设置为开发环境
                System.out.printf("\nSystem will automatically select 'd' in %d seconds.\n", automaticallyStartDelay);
                final int[] count = {automaticallyStartDelay};
                timer.scheduleAtFixedRate(new TimerTask() {
                    @Override
                    public void run() {
                        if (count[0]-- == 0) {
                            timer.cancel();
                            started[0] = true;

                            System.setProperty("spring.profiles.active", "development");
                            callback.bootRun();
                        }
                    }
                }, 0, 1000);
            }

            Scanner scanner = new Scanner(System.in);
            Pattern pattern = Pattern.compile("^p|d$");
            //若是是Linux系统(通常为生产环境)则强制等待用户输入(通常是忘记设置spring.profiles.active了，这等于给了设置active profile的"second chance")
            while (scanner.hasNextLine()) {
                if (started[0]) {
                    break;
                }
                String line = scanner.nextLine();
                if (!pattern.matcher(line).find()) {
                    System.out.println("INVALID INPUT!");
                } else {
                    timer.cancel();
                    System.setProperty("spring.profiles.active", line.equals("d") ? "development" : "production");
                    callback.bootRun();
                    break;
                }
            }
        } else { //若是已经经过参数spring.profiles.active设置了active profile直接启动
            callback.bootRun();
        }
    }

    public void startup(Callback callback) {
        startup(this.enableAutomaticallyStart, this.automaticallyStartDelay, callback);
    }
}

复制代码

main()：安全

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
import org.springframework.context.ApplicationContext;

@EnableEurekaServer
@SpringBootApplication
public class App {

    private static final Logger LOGGER = LoggerFactory.getLogger(App.class);

    public static void main(String[] args) {
        new BootStarter().startup(() -> {
            ApplicationContext applicationContext = SpringApplication.run(App.class, args);
            for (String activeProfile : applicationContext.getEnvironment().getActiveProfiles()) {
                LOGGER.warn("***Running with profile: {}***", activeProfile);
            }
        });
    }
}
复制代码

运行效果(开发环境Mac OS)： bash

扩展：其实在这里咱们还能够发散一下思惟，基于spring-boot的应用比起传统spring应用的一大优点是本身能够掌控main()方法，有了这一点，咱们是能玩出不少花样来的，思路不要被局限在tomcat时代了。app

main法在手，天下我有。ide

2017-1-22更新：增长了线程安全的处理spring-boot

import org.apache.commons.lang3.StringUtils;

import java.util.Scanner;
import java.util.Timer;
import java.util.TimerTask;
import java.util.regex.Pattern;

public class BootStarter {

    private volatile boolean started;

    //用于后续Spring Boot操做的回调
    public interface Callback {
        void bootRun();
    }

    private boolean enableAutomaticallyStart = true;
    private int automaticallyStartDelay = 3;

    public boolean isEnableAutomaticallyStart() {
        return enableAutomaticallyStart;
    }

    public void setEnableAutomaticallyStart(boolean enableAutomaticallyStart) {
        this.enableAutomaticallyStart = enableAutomaticallyStart;
    }

    public int getAutomaticallyStartDelay() {
        return automaticallyStartDelay;
    }

    public void setAutomaticallyStartDelay(int automaticallyStartDelay) {
        this.automaticallyStartDelay = automaticallyStartDelay;
    }

    public void startup(boolean enableAutomaticallyStart, int automaticallyStartDelay, Callback callback) {
        if (StringUtils.isBlank(System.getProperty("spring.profiles.active"))) { //若是没有经过参数spring.profiles.active设置active profile则让用户在控制台本身选择
            System.out.println("***Please choose active profile:***\n\tp: production\n\td: development");

            Timer timer = new Timer();
            if (enableAutomaticallyStart && System.getProperty("os.name").lastIndexOf("Linux") == -1) { //若是当前操做系统环境为非Linux环境(通常为开发环境)则automaticallyStartDelay秒后自动设置为开发环境
                System.out.printf("\nSystem will automatically select 'd' in %d seconds.\n", automaticallyStartDelay);
                timer.scheduleAtFixedRate(new TimerTask() {

                    private ThreadLocal<Integer> countDown = ThreadLocal.withInitial(() -> automaticallyStartDelay);

                    @Override
                    public void run() {
                        if (countDown.get() == 0) {
                            timer.cancel();
                            started = true;

                            System.setProperty("spring.profiles.active", "development");
                            callback.bootRun();
                        }
                        countDown.set(countDown.get() - 1);
                    }
                }, 0, 1000);
            }

            Scanner scanner = new Scanner(System.in);
            Pattern pattern = Pattern.compile("^p|d$");
            //若是是Linux系统(通常为生产环境)则强制等待用户输入(通常是忘记设置spring.profiles.active了，这等于给了设置active profile的"second chance")
            while (scanner.hasNextLine()) {
                if (started) {
                    break;
                }
                String line = scanner.nextLine();
                if (!pattern.matcher(line).find()) {
                    System.out.println("INVALID INPUT!");
                } else {
                    timer.cancel();
                    System.setProperty("spring.profiles.active", line.equals("d") ? "development" : "production");
                    callback.bootRun();
                    break;
                }
            }
        } else { //若是已经经过参数spring.profiles.active设置了active profile直接启动
            callback.bootRun();
        }
    }

    public void startup(Callback callback) {
        startup(this.enableAutomaticallyStart, this.automaticallyStartDelay, callback);
    }
}

复制代码

2017-01-25更新：

补上了 try-with-resource

import org.apache.commons.lang3.StringUtils;

import java.util.Scanner;
import java.util.Timer;
import java.util.TimerTask;
import java.util.regex.Pattern;

public class BootStarter {

    private volatile boolean started;

    //用于后续Spring Boot操做的回调
    public interface Callback {
        void bootRun();
    }

    private boolean enableAutomaticallyStart = true;
    private int automaticallyStartDelay = 3;

    public boolean isEnableAutomaticallyStart() {
        return enableAutomaticallyStart;
    }

    public void setEnableAutomaticallyStart(boolean enableAutomaticallyStart) {
        this.enableAutomaticallyStart = enableAutomaticallyStart;
    }

    public int getAutomaticallyStartDelay() {
        return automaticallyStartDelay;
    }

    public void setAutomaticallyStartDelay(int automaticallyStartDelay) {
        this.automaticallyStartDelay = automaticallyStartDelay;
    }

    public void startup(boolean enableAutomaticallyStart, int automaticallyStartDelay, Callback callback) {
        if (StringUtils.isBlank(System.getProperty("spring.profiles.active"))) { //若是没有经过参数spring.profiles.active设置active profile则让用户在控制台本身选择
            System.out.println("***Please choose active profile:***\n\tp: production\n\td: development");

            Timer timer = new Timer();
            if (enableAutomaticallyStart && System.getProperty("os.name").lastIndexOf("Linux") == -1) { //若是当前操做系统环境为非Linux环境(通常为开发环境)则automaticallyStartDelay秒后自动设置为开发环境
                System.out.printf("\nSystem will automatically select 'd' in %d seconds.\n", automaticallyStartDelay);
                timer.scheduleAtFixedRate(new TimerTask() {

                    private ThreadLocal<Integer> countDown = ThreadLocal.withInitial(() -> automaticallyStartDelay);

                    @Override
                    public void run() {
                        if (countDown.get() == 0) {
                            timer.cancel();
                            started = true;

                            System.setProperty("spring.profiles.active", "development");
                            callback.bootRun();
                        }
                        countDown.set(countDown.get() - 1);
                    }
                }, 0, 1000);
            }

            try (Scanner scanner = new Scanner(System.in)) {
                Pattern pattern = Pattern.compile("^p|d$");
                //若是是Linux系统(通常为生产环境)则强制等待用户输入(通常是忘记设置spring.profiles.active了，这等于给了设置active profile的"second chance")
                while (scanner.hasNextLine()) {
                    if (started) {
                        break;
                    }
                    String line = scanner.nextLine();
                    if (!pattern.matcher(line).find()) {
                        System.out.println("INVALID INPUT!");
                    } else {
                        timer.cancel();
                        System.setProperty("spring.profiles.active", line.equals("d") ? "development" : "production");
                        callback.bootRun();
                        break;
                    }
                }
            }
        } else { //若是已经经过参数spring.profiles.active设置了active profile直接启动
            callback.bootRun();
        }
    }

    public void startup(Callback callback) {
        startup(this.enableAutomaticallyStart, this.automaticallyStartDelay, callback);
    }
}

复制代码