SpringCloud（Finchley版本）中Zull过滤器ResponseBoby返回中文乱码解决方案

Spring Cloud带有“Cloud”的字样，但它并不是云计算解决方案，而是在Spring Boot基础上构建的，用于快速构建分布式系统的通用模式的工具集。使用Spring Cloud开发的应用程序非常适合在Docker或者PaaS（例如Cloud Foundry）上部署，所以又叫做云原生应用（Cloud Native Application）。云原生（Cloud Native）可简单理解为面向云环境的软件架构。

Zuul作为SpringCloud的网关，在实际的开发中需要一些鉴权，有时候需要返回一些中文的，今天搭建的时候发现这玩意返回中文就乱码，网上找了很多资料，但是还没有解决，在我不懈的努力之下，最后终于解决了，此种方法能解决大部分的中文乱码问题。费话不多说了，直接上代码。项目结构如下：

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.0.3.RELEASE</version>
		<relativePath /> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.xz.springcloud</groupId>
	<artifactId>f-zuul-service</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>f-zuul-service</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
		<spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>

		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
		</dependency>
		
		<!-- 断点监控 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-actuator</artifactId>
		</dependency>
		
	</dependencies>

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>${spring-cloud.version}</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

ZullServiceApplication.java（启动类）

package com.xz.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

/**
 * 启动一个服务消费者
 * 
 * @author yuxuan
 *
 */
//启用Zuul代理
@EnableZuulProxy
@EnableDiscoveryClient
@SpringBootApplication
public class ZullServiceApplication {

	public static void main(String[] args) {
		SpringApplication.run(ZullServiceApplication.class, args);
	}

}

application.properties

#设置服务端口号
server.port = 9011


#应用程序名称
spring.application.name=zull-service

#eurake配置
eureka.client.service-url.defaultZone = http://localhost:9000/eureka/
# 是否注册IP到eureka server，如不指定或设为false，那就会注册主机名到eureka server
eureka.instance.prefer-ip-address=true
#发呆时间，即服务失效时间（缺省为90s）,就是超过15秒没有续约就会从注册表中剔除
eureka.instance.lease-expiration-duration-in-seconds=15
# 心跳时间，即服务续约间隔时间（缺省为30s）
eureka.instance.lease-renewal-interval-in-seconds=5

eureka.instance.instance-id: ${spring.application.name}:${server.port}

# 监控断点
management.endpoints.web.exposure.include=*
management.endpoint.health.show-details=always

#增加一个访问的前缀
zuul.prefix=/v1

# 表示API网关在进行请求路由转发前为请求设置Host头信息
zuul.add-host-header=true

#关闭全局的重试机制
#zuul.retryable=false
#关闭某个服务的重试机制
#zuul.routes.hystrix-feign-service-wb-user.retryable=false
##   这个地方一般定义到feign 服务进行负载
zuul.routes.hystrix-feign-service-wb-user=/api/**

#zuul.ignored-services.default=*
#zuul.routes.service-user=/api-user/**
#zuul.routes.service-order=/api-order/**

#通过URL进行映射
#zuul.routes.user-service.url=http://localhost:8080

#跳过orderservice，不创建映射
zuul.ignored-services=service-order,service-user

LoginFilter.java

package com.xz.springcloud.filter;

import javax.servlet.http.HttpServletRequest;

import org.springframework.stereotype.Component;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;

@Component
public class LoginFilter extends ZuulFilter{

	/**
	 * 过滤器的具体逻辑。需要注意，这里我们通过ctx.setSendZuulResponse(false)令zuul过滤该请求，不对其进行路由，然后通过ctx.setResponseStatusCode(401)设置了其返回的错误码，当然我们也可以进一步优化我们的返回，比如，
	 * 通过ctx.setResponseBody(body)对返回body内容进行编辑等。
	 */
	@Override
	public Object run() throws ZuulException {
		RequestContext requestContext = RequestContext.getCurrentContext();
		HttpServletRequest request = requestContext.getRequest();
		
		System.out.println(request.getRequestURL());
		
		String error = request.getParameter("error");
		if(error != null) {
			requestContext.setSendZuulResponse(false);
			requestContext.setResponseStatusCode(401);
			//重中之重，这里一定要加要给Response设置CharacterEncoding编码为UTF-8
			requestContext.getResponse().setCharacterEncoding("UTF-8");
			requestContext.getResponse().setContentType("text/html;cahrset=UTF-8");
			requestContext.setResponseBody("有错误未处理"+"："+error);
		}
		
		return null;
	}

	/**
	 * shouldFilter：返回一个boolean类型来判断该过滤器是否要执行，所以通过此函数可实现过滤器的开关。
	 * 在上例中，我们直接返回true，所以该过滤器总是生效。
	 */
	@Override
	public boolean shouldFilter() {
		// TODO Auto-generated method stub
		return true;
	}

	/**
	 * filterOrder：通过int值来定义过滤器的执行顺序
	 */
	@Override
	public int filterOrder() {
		// TODO Auto-generated method stub
		return 0;
	}

	@Override
	public String filterType() {
		/*
			filterType：返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：自定义过滤器的实现，需要继承ZuulFilter，需要重写实现下面四个方法：
			pre：可以在请求被路由之前调用
			routing：在路由请求时候被调用
			post：在routing和error过滤器之后被调用
			error：处理请求时发生错误时被调用
		*/
		return "pre";
	}

}

//重中之重，这里一定要加要给Response设置CharacterEncoding编码为UTF-8
requestContext.getResponse().setCharacterEncoding("UTF-8");

就这么一行代码就能解决中文乱码的问题，之前看了很多人把中文编码成URLEncoding的格式，但是在浏览器返回去还是有问题。

有问题可以在下面评论，技术问题可以私聊我。

 

转载于:https://www.cnblogs.com/c1024/p/11012001.html