From 5084ac39cf4f30ab476b2d96526f396834752e4d Mon Sep 17 00:00:00 2001
From: thinkgem <thinkgem@163.com>
Date: Wed, 24 Jul 2024 14:59:45 +0800
Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=20web.isDefaultResult=20?=
 =?UTF-8?q?=E5=8F=82=E6=95=B0=EF=BC=8C=E9=BB=98=E8=AE=A4=E5=85=A8=E5=B1=80?=
 =?UTF-8?q?=E8=BF=9B=E8=A1=8C=E6=8E=A5=E5=8F=A3=E7=BB=93=E6=9E=9C=E5=8C=85?=
 =?UTF-8?q?=E8=A3=85=E4=B8=BA=20{=20code:=20200,=20msg:=20"",=20data:=20{}?=
 =?UTF-8?q?=20|=20[]=20}=EF=BC=9B=E6=96=B0=E5=A2=9E=20web.resultParamName?=
 =?UTF-8?q?=20=E5=92=8C=20headerParamName=20=E5=8F=82=E6=95=B0=EF=BC=8C?=
 =?UTF-8?q?=E5=AF=B9=E4=B8=AA=E5=88=AB=E7=BB=93=E6=9E=9C=E8=BF=9B=E8=A1=8C?=
 =?UTF-8?q?=E5=8C=85=E8=A3=85?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../jeesite/common/web/http/ResultUtils.java  | 80 +++++++++++++++++++
 .../jeesite/common/web/http/ServletUtils.java | 36 ++++++---
 .../main/resources/config/jeesite-core.yml    | 10 ++-
 .../src/main/resources/config/application.yml |  8 ++
 web/src/main/resources/config/application.yml |  8 ++
 5 files changed, 129 insertions(+), 13 deletions(-)
 create mode 100644 common/src/main/java/com/jeesite/common/web/http/ResultUtils.java

diff --git a/common/src/main/java/com/jeesite/common/web/http/ResultUtils.java b/common/src/main/java/com/jeesite/common/web/http/ResultUtils.java
new file mode 100644
index 00000000..baa9d14e
--- /dev/null
+++ b/common/src/main/java/com/jeesite/common/web/http/ResultUtils.java
@@ -0,0 +1,80 @@
+/**
+ * Copyright (c) 2013-Now http://jeesite.com All rights reserved.
+ * No deletion without permission, or be held responsible to law.
+ */
+package com.jeesite.common.web.http;
+
+import com.jeesite.common.io.PropertiesUtils;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+
+/**
+ * 统一包装结果输出类：{ code: 200, msg: "", data: {} | [] }
+ * @author ThinkGem
+ * @version 2024-07-24
+ */
+public class ResultUtils {
+
+	private static final boolean isDefaultResult = PropertiesUtils.getInstance()
+			.getPropertyToBoolean("web.isDefaultResult", "false");
+	private static final String resultParamName = PropertiesUtils.getInstance()
+			.getProperty("web.resultParamName", "__data");
+	private static final String headerParamName = PropertiesUtils.getInstance()
+			.getProperty("web.headerParamName", "x-data");
+
+	/**
+	 * 设置 web.isResult 参数可强制全局使用统一结果输出，否则，传递 __data=true 参数，或 x-data 请求头为 true 时启用
+	 * @author ThinkGem
+	 */
+	public static Object result(Object data, HttpServletRequest request, HttpServletResponse response) {
+		if (request != null && response != null && (isDefaultResult || (
+				"true".equals(request.getParameter(resultParamName))
+						|| "true".equals(request.getHeader(headerParamName))))) {
+			Object msg = request.getAttribute("message");
+			return new Result(response.getStatus(), msg, data);
+		}
+		return data;
+	}
+
+	/**
+	 * 结果对象
+	 * @author ThinkGem
+	 * @version 2024-07-24
+	 */
+	private static class Result {
+		private int code;
+		private String msg;
+		private Object data;
+
+		public Result(int code, Object msg, Object data) {
+			this.code = code;
+			this.msg = msg != null ? msg.toString() : null;
+			this.data = data;
+		}
+
+		public int getCode() {
+			return code;
+		}
+
+		public void setCode(int code) {
+			this.code = code;
+		}
+
+		public String getMsg() {
+			return msg;
+		}
+
+		public void setMsg(String msg) {
+			this.msg = msg;
+		}
+
+		public Object getData() {
+			return data;
+		}
+
+		public void setData(Object data) {
+			this.data = data;
+		}
+	}
+
+}
diff --git a/common/src/main/java/com/jeesite/common/web/http/ServletUtils.java b/common/src/main/java/com/jeesite/common/web/http/ServletUtils.java
index 8bada0e7..fcf017a5 100644
--- a/common/src/main/java/com/jeesite/common/web/http/ServletUtils.java
+++ b/common/src/main/java/com/jeesite/common/web/http/ServletUtils.java
@@ -258,6 +258,7 @@ public class ServletUtils {
 		if (object == null) {
 			object = resultMap;
 		}
+		object = ResultUtils.result(object, request, response);
 		if (jsonView != null) {
 			return JsonMapper.toJson(object, jsonView);
 		}else {
@@ -331,6 +332,7 @@ public class ServletUtils {
 				object = new JSONPObject(functionName, object);
 			}
 		}
+		object = ResultUtils.result(object, request, response);
 		if (jsonView != null) {
 			return renderString(response, JsonMapper.toJson(object, jsonView));
 		}else {
@@ -358,18 +360,7 @@ public class ServletUtils {
 		try {
 //			response.reset(); // 注释掉，否则以前设置的Header会被清理掉，如ajax登录设置记住我的Cookie信息
 			if (type == null && StringUtils.isBlank(response.getContentType())){
-				if ((StringUtils.startsWith(string, "{") && StringUtils.endsWith(string, "}"))
-						|| (StringUtils.startsWith(string, "[") && StringUtils.endsWith(string, "]"))){
-					type = MediaType.APPLICATION_JSON_VALUE;
-				}else if (StringUtils.startsWith(string, "<") && StringUtils.endsWith(string, ">")){
-					if (StringUtils.startsWith(string, "<!DOCTYPE")){
-						type = MediaType.TEXT_HTML_VALUE;
-					}else{
-						type = MediaType.APPLICATION_XML_VALUE;
-					}
-				}else{
-					type = MediaType.TEXT_PLAIN_VALUE;
-				}
+				type = getContentType(string);
 			}
 			if (type != null) {
 				response.setContentType(type);
@@ -382,6 +373,27 @@ public class ServletUtils {
 		return null;
 	}
 
+	/**
+	 * 根据内容判断相应类型 MediaType
+	 * @return application/json、text/html、application/xml、text/plain
+	 */
+	public static String getContentType(String string) {
+		String type;
+		if ((StringUtils.startsWith(string, "{") && StringUtils.endsWith(string, "}"))
+				|| (StringUtils.startsWith(string, "[") && StringUtils.endsWith(string, "]"))){
+			type = MediaType.APPLICATION_JSON_VALUE;
+		}else if (StringUtils.startsWith(string, "<") && StringUtils.endsWith(string, ">")){
+			if (StringUtils.startsWith(string, "<!DOCTYPE")){
+				type = MediaType.TEXT_HTML_VALUE;
+			}else{
+				type = MediaType.APPLICATION_XML_VALUE;
+			}
+		}else{
+			type = MediaType.TEXT_PLAIN_VALUE;
+		}
+		return type;
+	}
+
 	/**
 	 * 获取请求的域名（含端口）
 	 */
diff --git a/modules/core/src/main/resources/config/jeesite-core.yml b/modules/core/src/main/resources/config/jeesite-core.yml
index 6b0384dd..735b68e0 100644
--- a/modules/core/src/main/resources/config/jeesite-core.yml
+++ b/modules/core/src/main/resources/config/jeesite-core.yml
@@ -116,7 +116,7 @@ adminPath: /a
 # 前端基础路径
 frontPath: /f
 
-# 加密设置
+# 加密设置（v5.8.1）
 encrypt:
   # 默认秘钥，可通过 AesUtils.genKeyString() 生成新秘钥 Hex 编码
   defaultKey: 9f58a20946b47e190003ec716c1c457d
@@ -600,6 +600,14 @@ web:
   ajaxParamName: __ajax
   ajaxHeaderName: x-ajax
 
+  # 是否默认对结果进行统一包装为：{ code: 200, msg: "", data: {} | [] }（v5.8.1）
+  # 注意：如果设置为 true 会对前端页面访问产生影响，暂时只为系统纯接口提供开启使用。
+  isDefaultResult: false
+
+  # 开启对接口结果数据进行包装的请求参数名和请求头名（v5.8.1）
+  resultParamName: __data
+  resultHeaderName: x-header
+
   # MVC 视图相关
   view:
     
diff --git a/web-api/src/main/resources/config/application.yml b/web-api/src/main/resources/config/application.yml
index f12a7888..9ba5ed6c 100644
--- a/web-api/src/main/resources/config/application.yml
+++ b/web-api/src/main/resources/config/application.yml
@@ -746,6 +746,14 @@ web:
 #  # AJAX 接受参数名和请求头名（v4.3.0）
 #  ajaxParamName: __ajax
 #  ajaxHeaderName: x-ajax
+#
+#  # 是否默认对结果进行统一包装为：{ code: 200, msg: "", data: {} | [] }（v5.8.1）
+#  # 注意：如果设置为 true 会对前端页面访问产生影响，暂时只为系统纯接口提供开启使用。
+#  isDefaultResult: false
+#
+#  # 开启对接口结果数据进行包装的请求参数名和请求头名（v5.8.1）
+#  resultParamName: __data
+#  resultHeaderName: x-header
 #  
 #  # MVC 视图相关
 #  view:
diff --git a/web/src/main/resources/config/application.yml b/web/src/main/resources/config/application.yml
index 0ff1c3a3..dfe1fac9 100644
--- a/web/src/main/resources/config/application.yml
+++ b/web/src/main/resources/config/application.yml
@@ -747,6 +747,14 @@ web:
 #  ajaxParamName: __ajax
 #  ajaxHeaderName: x-ajax
 #
+#  # 是否默认对结果进行统一包装为：{ code: 200, msg: "", data: {} | [] }（v5.8.1）
+#  # 注意：如果设置为 true 会对前端页面访问产生影响，暂时只为系统纯接口提供开启使用。
+#  isDefaultResult: false
+#
+#  # 开启对接口结果数据进行包装的请求参数名和请求头名（v5.8.1）
+#  resultParamName: __data
+#  resultHeaderName: x-header
+#
 #  # MVC 视图相关
 #  view:
 #