Spring Boot应用中如何获取主机URL以生成首页动态链接？

以下是几种实用的实现方式：

1. 通过HttpServletRequest直接提取信息 #

在请求处理方法中注入HttpServletRequest，从对象中获取协议、主机名和端口，拼接成符合要求的首页URL：

import javax.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HomeController {

    @GetMapping("/home-url")
    public String getHomeUrl(HttpServletRequest request) {
        String scheme = request.getScheme();
        String serverName = request.getServerName();
        int serverPort = request.getServerPort();
        
        // 处理默认端口（http默认80、https默认443），避免冗余端口号
        String homeUrl;
        if ((scheme.equals("http") && serverPort == 80) || (scheme.equals("https") && serverPort == 443)) {
            homeUrl = scheme + "://" + serverName + "/";
        } else {
            homeUrl = scheme + "://" + serverName + ":" + serverPort + "/";
        }
        return homeUrl;
    }
}

2. 使用Spring工具类ServletUriComponentsBuilder #

借助Spring提供的ServletUriComponentsBuilder，可以更简洁地从当前请求上下文构建URL：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;

@RestController
public class HomeController {

    @GetMapping("/home-url")
    public String getHomeUrl() {
        // fromCurrentContextPath()自动获取当前应用上下文路径，拼接斜杠得到首页地址
        return ServletUriComponentsBuilder.fromCurrentContextPath()
                .build()
                .toUriString() + "/";
    }
}

3. 非请求上下文场景（如定时任务）：从配置文件读取 #

如果不在请求处理流程中，可以提前在配置文件中定义主机信息，再注入拼接：

配置文件（application.properties）： #

app.scheme=https
app.host=localhost
app.port=8080

实现类： #

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class HomeUrlGenerator {

    @Value("${app.scheme}")
    private String scheme;

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

    @Value("${app.port}")
    private int port;

    public String getHomeUrl() {
        String homeUrl;
        if ((scheme.equals("http") && port == 80) || (scheme.equals("https") && port == 443)) {
            homeUrl = scheme + "://" + host + "/";
        } else {
            homeUrl = scheme + "://" + host + ":" + port + "/";
        }
        return homeUrl;
    }
}

内容的提问来源于stack exchange，提问作者jayaraj