实现过程
- 定义一个配置文件，后面可以在application.yml中通过配置实现代理不同网站。
@Getter
@Setter
@ConfigurationProperties(prefix = "proxy")
public class ProxyProperties {
private Map servers;
@Getter@Setter
public static class Server{
private String path;
private String target;
private String name;
}
} - 引入Spring依赖，在编写配置时可以自动提示。
org.springframework.boot
spring-boot-autoconfigure-processor
true
- 该功能实现的主要依赖。
org.mitre.dsmiley.httpproxy
smiley-http-proxy-servlet
2.0
- 增加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 servers = properties.getServers();
if( !CollectionUtils.isEmpty( servers ) ){
for(Map.Entry 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"
}
]
}优缺点
- 通过该方式实现首先需要有一个可以访问外网的服务器，同时该服务器和内网环境互通
- 如果需要添加认证模块，直接引入即可
- 如果代理的网站需要更多的信息才能访问，则需要进一步扩展
