解决请求响应乱码问题（使用Filter）

EzrealYi

---

前述：

     在写这篇笔记之前，对笔记中的设计模式进行介绍：

     本篇笔记中将要使用到的设计模式是：装饰（包装）设计模式

          （1）装饰（包装）设计模式口诀：

               ①定义一个类，实现被装饰对象的接口

               ②定义一个成员变量，记住被装饰对象的引用

               ③定义构造方法，传入被装饰对象的实例

               ④改写要修改的方法

               ⑤不需要改写的方法，调用被装饰对象的原来的方法

 

          （2）什么时候使用装饰设计模式

               当我们需要对一个类进行增强的时候，增强后的类不再当前类的范畴

                    例如：现在有一个     Animal类     Cat和Dog都属于动物类型，因此可以直接继承

                                                                      现在新来一个“电子狗 ”，不属于动物的范围，但是有需要用其中的方法，这时候我们选择使用装饰（包装）设计模式

 

一：需求：统一解决请求参数中文乱码

 

二、优化思路：

 使用一个过滤器，在请求到达servlet之前，先对request对象设置编码

 要求所有的请求都要进行设置编码，因此所有的request都要拦截，进行增强，那么web.xml应该加上：

<!-- 设置编码 -->
    <context-param>
        <param-name>charset</param-name>
        <param-value>UTF-8</param-value>
    </context-param>

    <!--配置乱码过滤器-->
    <filter>
        <filter-name>EncodingFilter</filter-name>
        <!--包名及文件名-->
        <filter-class>com.zy.web.Filter.EncodingFilter</filter-class>
        <init-param>
            <param-name>charset</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>EncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

三：代码实现：

     1、过滤器代码

package com.zy.web.Filter;

import com.zy.web.Encoding.EncodingRequest;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class EncodingFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
        // 将请求和响应强制转换成Http形式
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) res;

        String charset = request.getServletContext().getInitParameter("charset");
        if (charset == null || charset.isEmpty()) {
            charset = "UTF-8";
        }

        // 处理响应乱码
        response.setContentType("text/html;charset=" + charset);
        response.setCharacterEncoding(charset);
        EncodingRequest encodingRequest = new EncodingRequest(request, charset);
        chain.doFilter(encodingRequest, res);
    }

    @Override
    public void destroy() {

    }
}

2、自定义增强类（EncodingRequest）

package com.zy.web.Encoding;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.io.UnsupportedEncodingException;
import java.util.Map;
import java.util.Set;

public class EncodingRequest extends HttpServletRequestWrapper {
    private String charset;
    // 定义了一个成员变量，用来保存构造函数传入的requset对象
    private HttpServletRequest request = null;
    // 定义一个标记，用来标注：当前requset中，请求参数，是否已经编码过了
    private boolean flag = false;

    /**
     * Constructs a request object wrapping the given request.
     *
     * @param request the {@link HttpServletRequest} to be wrapped.
     * @param charset
     * @throws IllegalArgumentException if the request is null
     */
    public EncodingRequest(HttpServletRequest request, String charset) {
        super(request);
        this.charset = charset;
        this.request = request;
    }

    @Override
    public Map<String, String[]> getParameterMap() {
        // 获得请求方式request.getMethod()方法
        String method = this.request.getMethod();
        // post请求
        if ("post".equalsIgnoreCase(method)) {
            // 设置编码格式
            try {
                request.setCharacterEncoding(charset);
            } catch (UnsupportedEncodingException e) {
                e.printStackTrace();
            }
            Map<String, String[]> map = this.request.getParameterMap();
            return map;

        } else if ("get".equalsIgnoreCase(method)) {
            // get请求
            // 分析：get请求需要对每一个参数都进行转换，因此需要对map中的每个元素进行遍历
            // 首先获得map集合
            Map<String, String[]> map = this.request.getParameterMap();

            //第一次获取请求参数，flag==false，执行后面的额乱码处理动作
            //第二次获取请求参数的时候，flag==true，不执行后面的处理，直接返回已经编码过的map集合
            if (flag) {
                return map;
            }
            if (map == null) {
                return super.getParameterMap();
            } else {
                if (!map.isEmpty()) {
                    // 然后获得map集合的key
                    Set<String> key = map.keySet();

                    // 通过key将map中的元素取出来
                    for (String string1 : key) {
                        String[] value = map.get(string1);
                        // 接下来需要将String中的每一个都进行遍历，转换参数
                        for (int i = 0; i < value.length; i++) {
                            try {
                                String string2 = new String(
                                        value[i].getBytes("iso-8859-1"), charset);
                                value[i] = string2;
                            } catch (UnsupportedEncodingException e) {
                                e.printStackTrace();
                            }
                        }
                    }
                    flag = true;
                }
                return map;

            }
        } else {
            //位置请求方式，自定义对象处理不了，使用父类的方法处理
            return super.getParameterMap();
        }
    }

    @Override
    public String[] getParameterValues(String name) {
        //请求参数没有name,返回null
        if (name == null || name.equals("")) {
            return super.getParameterValues(name);
        } else {
            //请求没有任何param,返回""
            if (this.getParameterMap().isEmpty()) {
                return new String[0];
            } else {
                return this.getParameterMap().get(name);
            }
        }
    }

    @Override
    public String getParameter(String name) {
        if (name == null || name.equals("")) {
            return super.getParameter(name);
        } else {
            if(this.getParameterValues(name) == null){
                return null;
            }
            if (this.getParameterValues(name).length == 0) {
                return "";
            } else {
                return this.getParameterValues(name)[0];
            }
        }
    }
}

四、结果反馈

对于request.getParameter(Name)返回值为空时，接受对象的String为null，便于在jsp、servlet中判断处理结果。