Struts2 Action解析json数据

待我称王封你为后i 2022-04-02 10:58 245阅读 0赞

## 一.认识JSON ##

JSON是一种轻量级、基于文本、与语言无关的数据交换格式，可以用文本格式的形式来存储或表示结构化的数据。

## 二.POST请求与Content-Type: application/json ##

常用的HTTP请求方法有GET, POST, PUT, DELETE等。在提交POST请求时，请求数据放在消息体(Body)中，请求数据的格式及编码方式用Content-Type来指定。如我们常用的表单提交，其Content-Type默认为application/x-www-form-urlencoded，提交的数据按照key1=val1&key2=val2进行编码，服务器端也能很容易地解析K-V值。

JSON的出现，让交换的数据不再仅限于简单的K-V结构，而可以有更加复杂的层级，特别适合于RESTful接口。在发送请求时，指定Content-Type为application/json，即可使用JSON字符串作为请求的数据。而在服务器端接收到该请求后，将按照JSON字符串对请求数据进行处理。

## 三.Struts2接收JSON请求 ##

在Struts2的Action中提取Content-Type为application/x-www-form-urlencoded的POST参数，我们非常熟悉：`在Action中定义属性及其getter, setter方法，接收到请求时，默认会将与属性同名的参数值赋予该属性。`

但是对Content-Type为application/json的请求数据，Struts2默认无法解析。因为请求的JSON数据需从输入流中读取出来，无法直接从ServletRequest的请求参数中解析。很容易想到，要读取JSON请求数据，最直接的方式就是从输入流读取。而同时，Struts2的strus2-json-plugin也提供了有关的拦截器，对JSON请求数据进行解析。下面将对两种方案进行分析：

**1.从输入流中读取JSON请求数据，以下是在Action中实现的一个读取输入流数据的方法**

public class LoginAction  {
    	private JSONArray result;
    	
    	public JSONArray getResult() {
    		return result;
    	}
    
    	public void setResult(JSONArray result) {
    		this.result = result;
    	}
    	
    	//用户发送请求调用的函数
    	public String login()  {
    		System.out.println("=========login()=========");
    		HttpServletRequest request = ServletActionContext.getRequest();
    		String mpsStr = getRequestPostData(request);
    		System.out.println("参数为："+mpsStr);
    		
    		// 转化为json对象
    		JSONObject mpsObject = JSONObject.fromObject(mpsStr);
    		// 通过key获取value
    		String name = mpsObject.getString("name");
    		 String pass = mpsObject.getString("pass");
    		// 转化为实体类对象
    		//List<User> user= JSON.parseArray(jsonString,User.class);
    		
    		// 调用业务逻辑方法来处理登录请求
    		User user = new User();
    		user.setName(name);
    		user.setPassword(pass);
    		List r1 = mgr.validLogin(user);
    		result = JSONArray.fromObject(r1);
    		System.out.println("result="+result);
    		return "success";
    	}
    	
        //解析请求的Json数据函数
        private String getRequestPostData(HttpServletRequest request){
            int contentLength = request.getContentLength();
            String strResult = "";
            if(contentLength<0){
                return null;
            }
            try {
            byte buffer[] = new byte[contentLength];
            for (int i = 0; i < contentLength;) {
            	
                int len;
    				len = request.getInputStream().read(buffer, i, contentLength - i);
                if (len == -1) {
                    break;
                }
                i += len;
            }
            strResult = new String(buffer, "utf-8");
            } catch (IOException e) {
    			// TODO Auto-generated catch block
    			e.printStackTrace();
    		}
            return strResult;
        }
    }

**2.使用struts2-json-plugin配置**  
添加struts2-json-plugin的依赖，以maven配置为例：

<dependencies>
       ...
       <dependency>
           <groupId>org.apache.struts</groupId>
           <artifactId>struts2-json-plugin</artifactId>
           <version>STRUTS_VERSION</version>
       </dependency>
       ...
    </dependencies>

struts.xml配置文件添加JSON配置（粗体部分）

在Action中指定JSON数据中各个key及getter, setter，如请求的JSON数据如下，则在Action中定义名为type, message, code的属性及其getter, setter

{
        "type":10,
        "message": "this is a test msg",
        "code": 200
    }

这样，在接收到以上JSON请求数据时，Struts会默认将type, message, code的值解析出来。

## 四、struts2-json-plugin解析JSON请求数据的分析 ##

经过分析，struts2-json-plugin解析JSON请求数据，最核心的一个类是JSONIntercepter类。该拦截器的主要工作就是：`读取JSON请求数据，将JSON数据提取出K-V值并设置到Action的属性中`。步骤如下:

**1、判断当前请求数据类型是否为JSON类型**

String contentType = request.getHeader("content-type");
     ...
     if ((contentType != null) && contentType.equalsIgnoreCase("application/json")) {
        // load JSON object
         Object obj = JSONUtil.deserialize(request.getReader());
         ...
     }

**2、如果数据类型为JSON，从输入流中读取JSON数据，以下为JSONUtil类的deserialize方法**

public static Object deserialize(Reader reader) throws JSONException {
             // read content
             BufferedReader bufferReader = new BufferedReader(reader);
             String line;
             StringBuilder buffer = new StringBuilder();
     
             try {
                while ((line = bufferReader.readLine()) != null) {
                     buffer.append(line);
                }
            } catch (IOException e) {
                throw new JSONException(e);
             } 
             
             return deserialize(buffer.toString());
         }

**3、解析得到JSON对象后，遍历JSON对象，取出K-V，通过反射的V设置给予K相同的属性**