之前的文章中介绍过Spring Boot开发中统一修改http响应体内容的方法
spring-boot中统一修改http响应体内容的方法
今天给大家再介绍另一种方案也能实现同样的效果,那就是JavaEE中通过使用Filter过滤器来修改http响应体~
JavaEE中提供了HttpServletResponseWrapper,该类实现了HttpServletResponse接口,通过重写该类的getOutputStream、getWriter方法来拦截Servlet响应内容,结合Filter的使用,就可以在Filter中统一修改http响应体了
JavaEE官方文档说明:https://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletResponseWrapper.html
1.编写HttpServletResponseWrapper的实现类,来包装HttpServletResponse,等下在Filter中会用于替换真正的HttpServletResponse对象
示例代码:https://github.com/netbuffer/javaee-demo/blob/master/src/main/java/cn/netbuffer/filter/wrapper/ModifyHttpResponseWrapper.java
public class ModifyHttpResponseWrapper extends HttpServletResponseWrapper {
private CharArrayWriter bufferWriter;
private ByteArrayOutputStream byteArrayOutputStream=new ByteArrayOutputStream();
private HttpServletResponse httpServletResponse;
public ModifyHttpResponseWrapper(HttpServletResponse response) {
super(response);
bufferWriter=new CharArrayWriter();
httpServletResponse=response;
}
@Override
public ServletOutputStream getOutputStream() {
return new ServletOutputStreamWrapper(this.byteArrayOutputStream, this.httpServletResponse);
}
@Override
public PrintWriter getWriter() throws IOException {
return new PrintWriter(bufferWriter);
}
public String getResult() {
return bufferWriter.toString();
}
public String getContent() {
return new String(byteArrayOutputStream.toByteArray());
}
@Override
public void setContentType(String type) {
super.setContentType(type);
}
private class ServletOutputStreamWrapper extends ServletOutputStream {
private ByteArrayOutputStream outputStream;
private HttpServletResponse response;
public ServletOutputStreamWrapper(ByteArrayOutputStream byteArrayOutputStream, HttpServletResponse response) {
this.outputStream=byteArrayOutputStream;
this.response=response;
}
@Override
public boolean isReady() {
return true;
}
@Override
public void setWriteListener(WriteListener listener) {
}
@Override
public void write(int b) throws IOException {
this.outputStream.write(b);
}
@Override
public void flush() throws IOException {
if (!this.response.isCommitted()) {
byte[] body=this.outputStream.toByteArray();
ServletOutputStream outputStream=this.response.getOutputStream();
outputStream.write(body);
outputStream.flush();
}
}
}
}
2.编写Filter过滤器来拦截http响应,达到最终修改http响应体的目的
示例代码:https://github.com/netbuffer/javaee-demo/blob/master/src/main/java/cn/netbuffer/filter/ModifyHttpResponseFilter.java
@WebFilter(filterName="ModifyHttpResponseFilter", urlPatterns={"/json/*"})
public class ModifyHttpResponseFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletResponse httpServletResponse=(HttpServletResponse) servletResponse;
ModifyHttpResponseWrapper modifyHttpResponseWrapper=new ModifyHttpResponseWrapper(httpServletResponse);
System.out.println("-----------------before ModifyHttpResponseFilter------------------");
filterChain.doFilter(servletRequest, modifyHttpResponseWrapper);
System.out.println("-----------------after ModifyHttpResponseFilter------------------");
JSONObject jsonObject=JSON.parseObject(StringUtils.isBlank(modifyHttpResponseWrapper.getResult()) ? modifyHttpResponseWrapper.getContent() : modifyHttpResponseWrapper.getResult());
jsonObject.put("msg", "wrapper[" + jsonObject.getString("msg") + "]");
HttpServletResponse response=(HttpServletResponse) modifyHttpResponseWrapper.getResponse();
response.setContentType("application/json; charset=UTF-8");
PrintWriter printWriter=response.getWriter();
printWriter.write(jsonObject.toJSONString());
printWriter.flush();
printWriter.close();
}
@Override
public void destroy() {
}
}
3.编写测试用的Servlet,来测试http响应体改写情况
完整示例代码:https://github.com/netbuffer/javaee-demo/blob/master/src/main/java/cn/netbuffer/servlet/JSONServlet.java
@WebServlet(name="jsonServlet", urlPatterns={"/json"})
public class JSONServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
JSONObject data=new JSONObject();
data.put("success", true);
data.put("msg", "invoke success for " + this.getClass().getName());
System.out.println("get json=" + data);
response.getWriter().write(data.toString());
}
}
启动工程,使用Postman工具访问/json接口测试
可以看到返回的数据中已经被wrapper[]包装了
请求执行流程
完整测试工程请参考:https://github.com/netbuffer/javaee-demo
明白了原理,JavaEE中的这种机制我们完全可以用在Spring Boot开发中~
示例伪代码:
//注册Filter过滤器来拦截响应内容,并修改最终的响应体
@Bean
public FilterRegistrationBean registration() {
FilterRegistrationBean registration=new FilterRegistrationBean();
//注册
registration.setFilter(new YourFilter());
registration.addUrlPatterns("/YourPath/*");
registration.setOrder(1000);
return registration;
}
示例过滤器,在doFilter中做自定义的逻辑处理,可以达到统一修改http响应体的效果~
public class YourFilter extends GenericFilterBean {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
//todo 自定义处理逻辑
}
}
完整代码写法可以参考我在spring-boot-admin issue中的回答:https://github.com/codecentric/spring-boot-admin/issues/1053#issuecomment-920630443
在 NGINX 中,sub_filter 和 subs_filter 是两个用于替换响应内容中字符串的指令,它们主要用于反向代理和修改响应内容。下面是它们之间的主要区别:
一般来说,如果只需要简单的字符串替换,使用 sub_filter 就足够了。如果需要更强大的正则表达式支持,可以使用 subs_filter。
示例:
# 使用 sub_filter 进行字符串替换
location / {
proxy_pass http://backend_server;
sub_filter 'http://backend_server' 'http://frontend_server';
sub_filter_once off; # 可选,允许多次替换,默认为 off。
}
# 使用 subs_filter 进行正则表达式替换
location / {
proxy_pass http://backend_server;
subs_filter 'http://backend_server' 'http://frontend_server' ig;
}
环境部署的详细过程,可以参考我这篇文章:NGINX - 高级负载均衡器、Web服务器、反向代理
官方地址:http://nginx.org
wget https://nginx.org/download/nginx-1.24.0.tar.gz
tar -xf nginx-1.24.0.tar.gz
# 编译部署
yum install -y gcc pcre-devel openssl-devel
./configure --prefix=/usr/local/nginx --with-http_ssl_module --with-http_stub_status_module
make
make install
sub_filter 是 NGINX 提供的用于在响应内容中进行简单字符串替换的指令。它的基本语法如下:
sub_filter old_string new_string;
这里是一个详细示例,演示如何在 NGINX 中使用 sub_filter 进行字符串替换:
假设有一个后端服务器返回的 HTML 页面,其中包含了字符串 "Hello, World!",而我们希望将其替换为 "Hello, NGINX!"。
server {
listen 80;
server_name example.com;
location / {
proxy_pass http://backend_server;
# 使用 sub_filter 进行字符串替换
sub_filter 'Hello, World!' 'Hello, NGINX!';
sub_filter_once off; # 可选,允许多次替换,默认为 off。
}
}
在这个配置中:
这样,当 NGINX 收到来自后端服务器的响应时,会在响应内容中查找并替换 "Hello, World!" 为 "Hello, NGINX!"。这种功能常用于在反向代理过程中修改响应内容,例如替换页面上的链接、域名或其他字符串。
请注意,sub_filter 只能进行简单的字符串匹配和替换,不支持正则表达式。如果需要更复杂的匹配和替换操作,可以考虑使用 subs_filter,该指令支持正则表达式。
subs_filter 是 NGINX 的 ngx_http_sub_module 模块提供的指令,它可以在响应内容中使用正则表达式进行字符串替换。这使得它比 sub_filter 更灵活,能够处理更复杂的匹配和替换操作。
开始重新编译NGINX 支持 sub_filter 指令
git clone git://github.com/yaoweibin/ngx_http_substitutions_filter_module.git
# 开始重新编译
# ./configure --add-module=/path/to/module
./configure --prefix=/usr/local/nginx --add-module=./ngx_http_substitutions_filter_module --with-http_ssl_module --with-http_stub_status_module
# 安装
make && make install
# 重启nginx
pkill -9 nginx
nginx
# 检查
nginx -V
以下是一个详细的示例,演示如何在 NGINX 中使用 subs_filter:
假设有一个后端服务器返回的 HTML 页面,其中包含了一组链接,而我们希望将这些链接的域名替换为新的域名。
server {
listen 80;
server_name example.com;
location / {
proxy_pass http://backend_server;
# 使用 subs_filter 进行正则表达式替换
subs_filter 'http://old_domain.com' 'http://new_domain.com' ig;
}
}
在这个配置中:
使用正则表达式的好处是可以更灵活地匹配多个可能的变体,而不仅仅是一个精确的字符串。
请注意,subs_filter 的语法是:
subs_filter pattern replacement [flags] [r=number];
下面是一个示例,演示如何使用 r 参数进行替换字符串的格式控制:
location / {
proxy_pass http://backend_server;
# 使用 subs_filter 进行正则表达式替换,并指定 r 参数
subs_filter '(\d+)' '<span class="number">$1</span>' ig r;
}
通过使用 r 参数,可以在替换字符串中使用正则表达式匹配到的内容,从而实现更灵活的替换操作。
通过使用 subs_filter,可以在 NGINX 中执行更复杂的字符串替换操作,以满足特定的需求。
NGINX sub_filter和subs_filter 指令的讲解就先到这里了,有任何疑问也可关注我公众号:大数据与云原生技术分享,进行技术交流,如本篇文章对您有所帮助,麻烦帮忙一键三连(点赞、转发、收藏)~
rowserMob Proxy 是一款基于 Java 的开源工具,广泛用于监控和操作网络流量。这对于开发者和测试工程师来说是一个非常有用的工具,尤其是在进行自动化测试和网络优化时。以下是一个关于如何使用 BrowserMob Proxy 的入门指南。
BrowserMob Proxy 允许你截取、查看和修改浏览器或应用程序的网络请求和响应。这在自动化测试中尤为重要,可以用来验证应用程序如何与网络接口交互,或者模拟网络条件对应用行为的影响。
GitHub地址
https://github.com/lightbody/browsermob-proxy
要开始使用 BrowserMob Proxy,首先需要将其集成到你的 Java 项目中。可以通过 Maven 来管理依赖:
<dependency>
<groupId>net.lightbody.bmp</groupId>
<artifactId>browsermob-core</artifactId>
<version>2.1.5</version>
</dependency>
确保你的开发环境已经安装了 Maven 和 Java。
BrowserMob Proxy 通过创建一个本地代理服务器来工作。以下是如何在 Java 代码中启动和设置代理服务器:
BrowserMobProxy proxy=new BrowserMobProxyServer();
proxy.start(0); // 0 表示自动选择一个可用端口
System.out.println("Proxy started on port: " + proxy.getPort());
如果你使用 Selenium 进行自动化测试,需要配置 WebDriver 以使用 BrowserMob Proxy。这样,所有通过 WebDriver 发起的请求都会经过代理服务器:
System.setProperty("webdriver.gecko.driver", "path/to/geckodriver");
WebDriver driver=new FirefoxDriver();
Proxy seleniumProxy=ClientUtil.createSeleniumProxy(proxy);
BrowserMob Proxy 最强大的功能之一是能够拦截和修改进出的网络请求和响应。以下是一个示例,展示如何修改对特定 JavaScript 文件的响应:
proxy.addResponseFilter((response, contents, messageInfo) -> {
if (messageInfo.getOriginalUrl().contains("http://a.b.c/d.js")) {
String content=contents.getTextContents();
String modifiedContent=content.replace("oldFunction()", "newFunction()");
contents.setTextContents(modifiedContent);
}
});
使用 BrowserMob Proxy 拦截 HTTPS 流量时,可能需要安装并信任由 BrowserMob Proxy 动态生成的 CA 证书,以避免 SSL 错误。
通过以上步骤,你可以开始使用 BrowserMob Proxy 来增强你的开发和测试工作。这个工具不仅可以帮助你更好地理解应用如何与网络交互,还可以用于测试应用在不同网络条件下的表现。
*请认真填写需求信息,我们会在24小时内与您取得联系。