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的格式，但是在瀏覽器返回去還是有問題。

有問題可以在下面評論，技術問題可以私聊我。