Spring Boot/Cloud 端口设置、端口随机、端口自增如何实现？_springboot项目端口自增长

Spring Boot/Cloud 端口设置、端口随机、端口自增如何实现？

• Spring Boot 、Spring Cloud支持固定端口和随机端口2种方式，但是这两种方式都不利于管理
• 固定端口容易冲突，特别是在Spring Cloud下，用起来很麻烦
• 随机端口看似解决了端口冲突的问题，但是天知道它随机到哪个端口去了
• 本文介绍3种端口设置的方式：固定端口、范围内随机端口、范围内自增长端口
• 本文均以properties文件的方式描述配置
• 搜索微信小程序【数字续坚】在资源中搜索【端口自增】可下载本文所述源代码

1. 固定端口

• 固定端口是最常见的方式，在配置文件中配置即可，properties的方式如下

# 默认固定端口方式
server.port=8080
# 或从指定环境变量取值
server.port=${env.name}
1
2
3
4

2.随机端口

• 在指定范围内随机使用一个端口，这也是官方支持的一种方式

# 端口从 10000 到 19999 随机取一个
server.port=${random.int[10000,19999]}
1
2

3.按照自定义策略选择端口

• 实现方式是结合“1.固定端口”的从环境变量取值的变种
• 在搜索微信小程序【数字续坚】在资源中搜索【端口自增】可下载本文所述源代码DEMO
• 实现方式如下：

3.1 配置文件

# 环境变量可以修改，写死为8080或其他也行
server.port=${env.name}
1
2

3.2 代码实现逻辑

• 以下方法为main方法中的
• 以下代码可以再优化优化哈
• DEMO中词此部分代码注释掉了

@SpringBootApplication
public class L3Application {

    public static void main(String[] args) {
        //设置对应的环境变量，如果没有特别设置，就写server.port
        System.setProperty("env.name", L3Application.getPort());
        SpringApplication.run(L3Application.class,args);
    }

    public static String getPort(){
        //TODO 按照你的逻辑返回端口即可
        //某个条件
//        if(CONDITION){
//            //某个端口
//            return "5555";
//        }
        return "44455";
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

4.自增长端口

• 实际上，实现方式可以参考“3.按照自定义策略选择端口”的方式，把端口逻辑改为递增就行了
• 本文介绍采用Spring Boot/Cloud的方式实现

4.1 配置文件

# 以下内容和规则都是自定义的
server.port=${randomServerPort.value:8888,9999}
1
2

4.2 SpringApplication Main方法中

• 添加ApplicationListener的ApplicationEnvironmentPreparedEvent

@SpringBootApplication
public class L3Application {

    public static void main(String[] args) {
        SpringApplication app = new SpringApplication(L3Application.class);
        app.addListeners(new ApplicationListener<ApplicationEnvironmentPreparedEvent>() {
            @Override
            public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
            	//IncrServerPort见下一节内容
                event.getEnvironment().getPropertySources().addLast(new IncrServerPort());
            }
        });
        app.run(args);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

4.3 IncrServerPort（PropertySource）实现

import lombok.extern.slf4j.Slf4j;
import org.springframework.core.env.PropertySource;

@Slf4j
public class IncrServerPort extends PropertySource<RandomServerPort> {

    //与配置文件一致即可
    private final static String RANDOM_SERVER_PORT_PROPERTY_SOURCE_NAME = "randomServerPort";

    //与配置文件一致即可，注意后面有个英文点
    private static final String PREFIX = "randomServerPort.";


    public IncrServerPort() {
        super(RANDOM_SERVER_PORT_PROPERTY_SOURCE_NAME,new RandomServerPort());
    }

    @Override
    public Object getProperty(String name) {
        if (!name.startsWith(PREFIX)) {
            return null;
        }
        return getRandomServerPortValue(name.substring(PREFIX.length()));
    }

    /**
     * 本方法实际上即为，自增端口的一种逻辑：
     * 通过轮询的方式检查本地端口是否可用，不可用则+1再试
     * */
    private int getRandomServerPortValue(String values){
        values = values.replace("value:","");
        String[] ports = values.split(",");
        try{
            if(ports.length == 0){
          		//详细逻辑实现代码：ports[0] 到 65535
                return new RandomServerPort().value(Integer.parseInt(ports[0]));
            }else{
          		//详细逻辑实现代码：ports[0] 到 ports[1]
                return new RandomServerPort().value(Integer.parseInt(ports[0]),Integer.parseInt(ports[1]));
            }
        }catch (Exception e){
            e.printStackTrace();
            return 8080;
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

4.4 详细逻辑实现

@Slf4j
public class RandomServerPort {

    public int value(int start) {
        return value(start, 65535);
    }

    public int value(int start, int end) {
        log.info("Now checking server port from {} to {}.",start,end);
        for(int port = start;port < end;port ++){
            //如果端口能连接上，则说明该端口已经被占用了，那就该尝试下一端口
            if(!checkIpPort("127.0.0.1",port)){
                return port;
            }else{
                log.error("Port {} is not available, now checking the next port.", port);
            }
        }
        log.error("No available port for this project.");
        return start;
    }

    /**
     * 检测Ip和端口是否可用
     *
     * @param ip
     * @param port
     * @return
     */
    private boolean checkIpPort(String ip, int port) {
        Socket socket = new Socket();
        try {
            socket.connect(new InetSocketAddress(ip,port),10);
            return true;
        } catch (Exception e) {
            return false;
        } finally {
            if (socket != null) {
                try {
                    socket.close();
                } catch (IOException e) {
                }
            }
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

5.自增长端口

• 在搜索微信小程序【数字续坚】在资源中搜索【端口自增】可下载本文所述源代码demo
• demo中示例内容比较多，您从main方法看就行了