详解如何通过Java实现类似Nginx代理

 更新时间:2024年08月05日 11:02:15   作者:Java技术指北  
最近遇到一个问题,在内网环境中部署的项目需要调用外网完成一些应用,一般情况我们可以通过增加一台机器,部署到可以访问外网的服务器上,然后内网直接连接该机器通过Nginx进行代理即可,所以本文介绍了如何通过Java实现类似Nginx代理,需要的朋友可以参考下

proxy-spring-boot-starter

最近遇到一个问题,在内网环境中部署的项目需要调用外网完成一些应用,一般情况我们可以通过增加一台机器,部署到可以访问外网的服务器上,然后内网直接连接该机器通过Nginx进行代理即可。但是出于安全考虑以及各个服务都是由多个微服务组成,需要接入SSO实现认证后才能访问

实现过程

  • 定义一个配置文件,后面可以在application.yml中通过配置实现代理不同网站

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

    /**
     * 需要代理的服务列表
     */
    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> 
  • 该功能实现的主要依赖

<dependency>
    <groupId>org.mitre.dsmiley.httpproxy</groupId>
    <artifactId>smiley-http-proxy-servlet</artifactId>
    <version>2.0</version>
</dependency>
  • 增加AutoConfiguration,包含两个步骤

a) 定义一个ProxyServletConfiguration配置 这里我们基于ImportBeanDefinitionRegistrar接口,动态读取代理服务列表,然后通过ServletRegistrationBean创建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("开始注册服务代理:{} ( {} => {})", 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 服务器响应标头中保持 cookie 路径不变
        servletRegistrationBean.addInitParameter(ProxyServlet.P_PRESERVECOOKIEPATH, String.valueOf(true));
//        // 保持 HOST 参数不变
//        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

使用方法

使用方式非常简单,在配置文件中添加代理的配置,启动服务即可

  • 修改配置文件application.yml

proxy:
  servers:
    Baidu:
      path: /baidu/*
      target: 'https://www.baidu.com'
      name: 百度
    Shici:
      path: /shici/*
      target: 'https://v1.jinrishici.com'
      name: 诗词
  • 启动服务

  • 示例 http://localhost:8080/shici

可以看到返回的内容与https://v1.jinrishici.com相同

{
  "welcome": "欢迎使用古诗词·一言",
  "api-document": "下面为本API可用的所有类型,使用时,在链接最后面加上 .svg / .txt / .json / .png 可以获得不同格式的输出",
  "help": "具体安装方法请访问项目首页 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"
    }
  ]
}

优缺点

  • 通过该方式实现首先需要有一个可以访问外网的服务器,同时该服务器和内网环境互通

  • 如果需要添加认证模块,直接引入即可

  • 如果代理的网站需要更多的信息才能访问,则需要进一步扩展

写在最后

到此这篇关于详解如何通过Java实现类似Nginx代理的文章就介绍到这了,更多相关Java实现Nginx代理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java调用用户芝麻信用分

    Java调用用户芝麻信用分

    这篇文章主要为大家详细介绍了Java调用用户芝麻信用分,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-11-11
  • Java中Cookie和Session详解及区别总结

    Java中Cookie和Session详解及区别总结

    这篇文章主要介绍了Java中Cookie和Session详解,文章围绕主题展开详细的内容介绍,具有一定的参考价值,感兴趣的小伙伴可以参考一下
    2022-06-06
  • 浅谈slf4j中的桥接器是如何运作的

    浅谈slf4j中的桥接器是如何运作的

    这篇文章主要介绍了slf4j中的桥接器是如何运作的,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12
  • spring mvc利用ajax向controller传递对象的方法示例

    spring mvc利用ajax向controller传递对象的方法示例

    这篇文章主要给大家介绍了关于spring mvc利用ajax向controller传递对象的相关资料,文中通过示例代码将步骤介绍的非常详细,对大家具有一定的参考学习价值,需要的朋友们下面来跟着小编一起学习学习吧。
    2017-07-07
  • jwt生成token和token解析基础详解

    jwt生成token和token解析基础详解

    这篇文章主要为大家介绍了jwt生成token和token解析基础,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-11-11
  • Junit写法及与spring整合过程详解

    Junit写法及与spring整合过程详解

    这篇文章主要介绍了Junit写法及与spring整合过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • springboot+vue实现登录功能的最新方法整理

    springboot+vue实现登录功能的最新方法整理

    最近做项目时使用到了springboot+vue实现登录功能的技术,所以下面这篇文章主要给大家介绍了关于springboot+vue实现登录功能的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-06-06
  • springboot使用Logback把日志输出到控制台或输出到文件

    springboot使用Logback把日志输出到控制台或输出到文件

    这篇文章给大家介绍springboot项目使用日志工具Logback把日志不仅输出到控制台,也可以输出到文件的操作方法,本文通过实例图文相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2020-10-10
  • SpringBoot Web项目增删改查入门实战案例

    SpringBoot Web项目增删改查入门实战案例

    这篇文章主要给大家介绍了关于SpringBoot Web项目增删改查入门实战的相关资料,文中详细介绍了如何实现新增、删除、修改和查询员工的功能,并使用统一响应结果进行前后端交互,需要的朋友可以参考下
    2024-11-11
  • spring 自定义让@Value被解析到

    spring 自定义让@Value被解析到

    这篇文章主要介绍了spring 自定义让@Value被解析到,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09

最新评论