詳解如何通過Java實(shí)現(xiàn)類似Nginx代理

更新時間：2024年08月05日 11:02:15 作者：Java技術(shù)指北

最近遇到一個問題,在內(nèi)網(wǎng)環(huán)境中部署的項(xiàng)目需要調(diào)用外網(wǎng)完成一些應(yīng)用,一般情況我們可以通過增加一臺機(jī)器,部署到可以訪問外網(wǎng)的服務(wù)器上,然后內(nèi)網(wǎng)直接連接該機(jī)器通過Nginx進(jìn)行代理即可,所以本文介紹了如何通過Java實(shí)現(xiàn)類似Nginx代理,需要的朋友可以參考下

proxy-spring-boot-starter

最近遇到一個問題，在內(nèi)網(wǎng)環(huán)境中部署的項(xiàng)目需要調(diào)用外網(wǎng)完成一些應(yīng)用，一般情況我們可以通過增加一臺機(jī)器，部署到可以訪問外網(wǎng)的服務(wù)器上，然后內(nèi)網(wǎng)直接連接該機(jī)器通過Nginx進(jìn)行代理即可。但是出于安全考慮以及各個服務(wù)都是由多個微服務(wù)組成，需要接入SSO實(shí)現(xiàn)認(rèn)證后才能訪問

實(shí)現(xiàn)過程

定義一個配置文件，后面可以在application.yml中通過配置實(shí)現(xiàn)代理不同網(wǎng)站

@Getter
@Setter
@ConfigurationProperties(prefix = "proxy")
public class ProxyProperties {

    /**
     * 需要代理的服務(wù)列表
     */
    private Map<String,Server> servers;

    /**
     *
     */
    @Getter@Setter
    public static class Server{

        private String path;

        private String target;

        private String name;

    }

}

引入Spring依賴，在編寫配置時可以自動提示

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure-processor</artifactId>
    <optional>true</optional>
</dependency>

該功能實(shí)現(xiàn)的主要依賴

<dependency>
    <groupId>org.mitre.dsmiley.httpproxy</groupId>
    <artifactId>smiley-http-proxy-servlet</artifactId>
    <version>2.0</version>
</dependency>

增加AutoConfiguration，包含兩個步驟

a) 定義一個ProxyServletConfiguration配置這里我們基于ImportBeanDefinitionRegistrar接口，動態(tài)讀取代理服務(wù)列表，然后通過ServletRegistrationBean創(chuàng)建Servlet代碼

public static class ProxyServleImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar, EnvironmentAware {

        private ProxyProperties properties;

        @Override
        public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
            Map<String, ProxyProperties.Server> servers = properties.getServers();
            if( !CollectionUtils.isEmpty( servers ) ){
                for(Map.Entry<String, ProxyProperties.Server> entry : servers.entrySet()){
                    ProxyProperties.Server server = entry.getValue();
                    LOGGER.info("開始注冊服務(wù)代理：{} ( {} => {})", server.getName(), server.getPath(), server.getTarget());
                    BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(ServletRegistrationBean.class);
//                    builder.addConstructorArgValue(new ProxyServlet() ).addConstructorArgValue(server.getPath());
                    builder.setFactoryMethodOnBean("getServletRegistrationBean", "proxyServletFactory");
                    builder.addConstructorArgValue(entry.getKey()).addConstructorArgValue(entry.getValue());
                    registry.registerBeanDefinition(entry.getKey()+"ServletRegistrationBean", builder.getBeanDefinition());
                }
            }
        }

        @Override
        public void setEnvironment(Environment environment) {
            String prefix = Objects.requireNonNull(AnnotationUtils.getAnnotation(ProxyProperties.class, ConfigurationProperties.class)).prefix();
            properties = Binder.get(environment).bind(prefix, ProxyProperties.class).get();
        }

    }

  public static ServletRegistrationBean createServletRegistrationBean(String key, ProxyProperties.Server server){
        ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(new ProxyServlet(), server.getPath());
        servletRegistrationBean.setName(server.getName());
        servletRegistrationBean.addInitParameter(ProxyServlet.P_TARGET_URI, server.getTarget());
        servletRegistrationBean.addInitParameter(ProxyServlet.P_LOG, String.valueOf(true));
        // 自動處理重定向
//        servletRegistrationBean.addInitParameter(ProxyServlet.P_HANDLEREDIRECTS, String.valueOf(false));
//        // 保持 COOKIES 不變
        servletRegistrationBean.addInitParameter(ProxyServlet.P_PRESERVECOOKIES, String.valueOf(true));
//        // Set-Cookie 服務(wù)器響應(yīng)標(biāo)頭中保持 cookie 路徑不變
        servletRegistrationBean.addInitParameter(ProxyServlet.P_PRESERVECOOKIEPATH, String.valueOf(true));
//        // 保持 HOST 參數(shù)不變
//        servletRegistrationBean.addInitParameter(ProxyServlet.P_PRESERVEHOST, String.valueOf(true));
        return servletRegistrationBean;
    }

b) 通過在src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports中引入上面的配置，這樣其他模塊只需要引入該jar則會由Spring自動注入 Configuration

cn.cycad.proxy.config.ProxyServletConfiguration

使用方法

使用方式非常簡單，在配置文件中添加代理的配置，啟動服務(wù)即可

修改配置文件application.yml

proxy:
  servers:
    Baidu:
      path: /baidu/*
      target: 'https://www.baidu.com'
      name: 百度
    Shici:
      path: /shici/*
      target: 'https://v1.jinrishici.com'
      name: 詩詞

啟動服務(wù)
示例 http://localhost:8080/shici

可以看到返回的內(nèi)容與https://v1.jinrishici.com相同

{
  "welcome": "歡迎使用古詩詞·一言",
  "api-document": "下面為本API可用的所有類型，使用時，在鏈接最后面加上 .svg / .txt / .json / .png 可以獲得不同格式的輸出",
  "help": "具體安裝方法請?jiān)L問項(xiàng)目首頁 https://gushi.ci/",
  "list": [
    {
      "全部": "https://v1.jinrishici.com/all"
    },
    {
      "抒情": "https://v1.jinrishici.com/shuqing"
    },
    {
      "四季": "https://v1.jinrishici.com/siji"
    },
    {
      "山水": "https://v1.jinrishici.com/shanshui"
    },
    {
      "天氣": "https://v1.jinrishici.com/tianqi"
    }
  ]
}