springboot 配置服务代理
有时候,我们可能有下边这样的需求:
即,针对于分布式服务,我们会有多种业务接口服务,但是服务器上可能只要求开放一个服务的端口,比如上图的restA
项目端口是对外开放的,但是restB
项目端口并未对外开放,这样带来的问题就是,用户无法直接请求restB
项目。
那就想到了可以通过访问restA
,请求路径符合一定规范的时候,比如http://ip:port/test
,当请求中以rest
开头时,可以再转发请求到restB
项目中即可。
当然代理转发
,有很多的解决办法,nginx
、zuul
等都可以实现,但是nginx
虽然简单,但是总要多装一个服务;zuul
配置较为麻烦。
经过百度后,发现了一个特别简单的配置,即这里要说的东西,ServletRegistrationBean
的注入,相当于是引入servlet
,没有具体看过 。
下面写一下配置步骤:
1、项目结构及介绍
下面是我的项目结构,以下选中蓝色的项目为我们要配置的项目,其他的项目先忽略,是我们基于dubbo
和zookeeper
配置的时候用的。
关于这个项目的介绍是下边这样的,再配张图来介绍下:
上图中关于suiteoneservice
、suitetwoservice
、masterservice
项目是我们的服务接口发布方项目。在这里我只是画出来,跟我们要配置的内容是无关的。
suiteone
、suitetwo
项目端口没有外放,用户不能直接访问,而master
项目是可以直接访问的,所以用户是通过访问master
项目,再由master
项目对请求代理转发到这两个项目中。
2、具体配置步骤
主要的配置很少,都在master
项目中。
(1)引入依赖:
<!--ProxyFilter的引入依赖--><dependency><groupId>org.mitre.dsmiley.httpproxy</groupId><artifactId>smiley-http-proxy-servlet</artifactId><version>1.7</version></dependency>
(2)、配置一个配置类:
该类可以参照下载下来的,master
项目中的配置。
package microservice.sc.config;import org.mitre.dsmiley.httpproxy.ProxyServlet;
import org.springframework.boot.bind.RelaxedPropertyResolver;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;@Configuration
public class ProxyServletConfiguration implements EnvironmentAware {@Beanpublic ServletRegistrationBean servletRegistrationBean(){ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(new ProxyServlet(), propertyResolver.getProperty("servlet_url_one"));//这个setName必须要设置,并且多个的时候,名字需要不一样servletRegistrationBean.setName("suitone");servletRegistrationBean.addInitParameter("targetUri", propertyResolver.getProperty("target_url_one"));servletRegistrationBean.addInitParameter(ProxyServlet.P_LOG, propertyResolver.getProperty("logging_enabled", "false"));return servletRegistrationBean;}@Beanpublic ServletRegistrationBean servletRegistrationBean2(){ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(new ProxyServlet(), propertyResolver.getProperty("servlet_url_two"));//这个setName必须要设置,并且多个的时候,名字需要不一样servletRegistrationBean.setName("suittwo");servletRegistrationBean.addInitParameter("targetUri", propertyResolver.getProperty("target_url_two"));servletRegistrationBean.addInitParameter(ProxyServlet.P_LOG, propertyResolver.getProperty("logging_enabled", "false"));return servletRegistrationBean;}private RelaxedPropertyResolver propertyResolver;@Overridepublic void setEnvironment(Environment environment) {this.propertyResolver = new RelaxedPropertyResolver(environment, "proxy.test.");}
}
(3)、配置代理地址:
到master
项目的主配置文件,即application.properties
文件中,加入以下内容:
#请求testone时代理转发到30001项目中
proxy.test.servlet_url_one=/testone/*
proxy.test.target_url_one=http://localhost:30001#请求testtwo时代理转发到30002项目中
proxy.test.servlet_url_two=/testtwo/*
proxy.test.target_url_two=http://localhost:300021234567
上边的配置简单介绍一下,对于testone/*
这样的写法,意思就是当你的请求路径以testone
开头,比如http://localhost:30000/testone/test/get1
这样的路径,它请求的真实路径是http://localhost:30001/test/get1
。主要就是将testone
替换成对应的被代理路径而已,\*
的意思就是实际请求项目中接口的路径!!!
30001
端口即suiteone
项目,30002
端口即suitetwo
项目,下载项目之后,分别启动master
、suiteone
、suitetwo
项目的启动类,启动完成后,访问http://localhost:30000/testone/test/get1
,即会返回suiteone
项目test/get1
接口的内容。
这种配置对get
、post
请求都有效。
以上即是完整的配置内容。