Set json escape html (#346)

* SetJSONNotEscape接口不转义HTML符号

* 完善文档

* 适应老的编译器

* 适应老版编译器

README.md

@@ -58,8 +58,9 @@ gout 是go写的http 客户端，为提高工作效率而开发
             - [Set the data to the http request body](#Set-the-data-to-the-http-request-body)
             - [Parse the response body into a variable](#Parse-the-response-body-into-a-variable)
         - [json](#json)
-            - [Serialize json to request body](#Serialize-json-to-request-body)
-            - [Parsed http response body in json format](#Parsed-http-response-body-in-json-format)
+            - [Serialize json to request body](#serialize-json-to-request-body)
+            - [Parsed http response body in json format](#parsed-http-response-body-in-json-format)
+			- [Do not escape html characters](#do-not-escape-html-characters)
         - [yaml](#yaml)
         - [xml](#xml)
         - [form-data](#form-data)
@@ -862,6 +863,26 @@ func main() {
 }
 
 ``` 
+#### do not escape html characters
+* SetJSONNotEscape 和SetJSON唯一的区别就是不转义HTML字符
+```go
+err := gout.POST(ts.URL).
+			Debug(true).
+			SetJSONNotEscape(gout.H{"url": "http://www.com?a=b&c=d"}).
+			Do()
+
+//> POST / HTTP/1.1
+//> Content-Type: application/json
+//>
+
+//{
+//    "url": "http://www.com?a=b&c=d"
+//}
+
+//< HTTP/1.1 200 OK
+//< Date: Sun, 18 Dec 2022 14:05:21 GMT
+//< Content-Length: 0
+```
 ### yaml
 * SetYAML() 设置请求http body为yaml
 * BindYAML() 解析响应http body里面的yaml到结构体里面

color/color_core.go

@@ -9,6 +9,8 @@ import (
 	"sort"
 	"strconv"
 	"strings"
+
+	"github.com/guonaihong/gout/enjson"
 )
 
 // BodyType 区分body的类型
@@ -44,6 +46,7 @@ const emptyArray = startArray + endArray
 
 // Formatter 是颜色高亮核心结构体
 type Formatter struct {
+	escapeHTML      bool
 	KeyColor        *Color // 设置key的颜色
 	StringColor     *Color // 设置string的颜色
 	BoolColor       *Color // 设置bool的颜色
@@ -73,7 +76,7 @@ func strToObject(all []byte) (interface{}, error) {
 }
 
 // NewFormatEncoder 着色json/yaml/xml构造函数
-func NewFormatEncoder(r io.Reader, openColor bool, bodyType BodyType) *Formatter {
+func NewFormatEncoder(r io.Reader, openColor bool, bodyType BodyType, escapeHTML bool) *Formatter {
 	// 如果颜色没打开，或者bodyType为txt
 	if !openColor || bodyType == TxtType {
 		return nil
@@ -99,6 +102,7 @@ func NewFormatEncoder(r io.Reader, openColor bool, bodyType BodyType) *Formatter
 	}
 
 	f := &Formatter{
+		escapeHTML:      escapeHTML,
 		KeyColor:        New(true, FgWhite),
 		StringColor:     New(true, FgGreen),
 		BoolColor:       New(true, FgYellow),
@@ -215,7 +219,7 @@ func (f *Formatter) marshalValue(val interface{}, buf *bytes.Buffer, depth int)
 
 func (f *Formatter) marshalString(str string, buf *bytes.Buffer) {
 	if !f.RawStrings {
-		strBytes, _ := json.Marshal(str)
+		strBytes, _ := enjson.Marshal(str, f.escapeHTML)
 		str = string(strBytes)
 	}
 

color/color_core_test.go

@@ -27,7 +27,7 @@ func Test_ColorCore_NewFormat_Nil(t *testing.T) {
 	}
 
 	for index, d := range data {
-		assert.Nil(t, NewFormatEncoder(d.r, d.openColor, d.bodyType), fmt.Sprintf("fail index:%d", index))
+		assert.Nil(t, NewFormatEncoder(d.r, d.openColor, d.bodyType, true), fmt.Sprintf("fail index:%d", index))
 	}
 }
 
@@ -49,7 +49,7 @@ func Test_ColorCore_Read(t *testing.T) {
 }`
 
 	NoColor = false
-	f := NewFormatEncoder(strings.NewReader(j), true /*open color*/, JSONType)
+	f := NewFormatEncoder(strings.NewReader(j), true /*open color*/, JSONType, true)
 	var out bytes.Buffer
 
 	_, err := io.Copy(&out, f)

dataflow/dataflow.go

@@ -12,6 +12,7 @@ import (
 	"github.com/guonaihong/gout/debug"
 	"github.com/guonaihong/gout/decode"
 	"github.com/guonaihong/gout/encode"
+	"github.com/guonaihong/gout/enjson"
 	"github.com/guonaihong/gout/middler"
 	"github.com/guonaihong/gout/middleware/rsp/autodecodebody"
 	"github.com/guonaihong/gout/setting"
@@ -182,7 +183,16 @@ func (df *DataFlow) SetHeader(obj ...interface{}) *DataFlow {
 // SetJSON send json to the http body, Support raw json(string, []byte)/struct/map types
 func (df *DataFlow) SetJSON(obj interface{}) *DataFlow {
 	df.ReqBodyType = "json"
-	df.Req.bodyEncoder = encode.NewJSONEncode(obj)
+	df.EscapeHTML = true
+	df.Req.bodyEncoder = enjson.NewJSONEncode(obj, true)
+	return df
+}
+
+// SetJSON send json to the http body, Support raw json(string, []byte)/struct/map types
+// 与SetJSON的区一区别就是不转义HTML里面的标签
+func (df *DataFlow) SetJSONNotEscape(obj interface{}) *DataFlow {
+	df.ReqBodyType = "json"
+	df.Req.bodyEncoder = enjson.NewJSONEncode(obj, false)
 	return df
 }
 

dataflow/dataflow_json_test.go

@@ -0,0 +1,23 @@
+package dataflow
+
+import (
+	"bytes"
+	"fmt"
+	"testing"
+
+	"github.com/guonaihong/gout/debug"
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_SetJSONNotEscape(t *testing.T) {
+	ts := createGeneral("")
+	fmt.Println("url", ts.URL)
+	var buf bytes.Buffer
+	//POST(ts.URL).Debug(true).SetJSONNotEscape(map[string]any{"url": "http://www.com?a=b&c=d"}).Do()
+	POST(ts.URL).Debug(debug.ToWriter(&buf, false)).SetJSONNotEscape(map[string]interface{}{"url": "http://www.com?a=b&c=d"}).Do()
+	assert.True(t, bytes.Contains(buf.Bytes(), []byte("&")), buf.String())
+	buf.Reset()
+	//POST(ts.URL).Debug(true).SetJSON(map[string]any{"url": "http://www.com?a=b&c=d"}).Do()
+	POST(ts.URL).Debug(debug.ToWriter(&buf, false)).SetJSON(map[string]interface{}{"url": "http://www.com?a=b&c=d"}).Do()
+	assert.False(t, bytes.Contains(buf.Bytes(), []byte("&")), buf.String())
+}

dataflow/req.go

@@ -15,6 +15,7 @@ import (
 	"github.com/guonaihong/gout/debug"
 	"github.com/guonaihong/gout/decode"
 	"github.com/guonaihong/gout/encode"
+	"github.com/guonaihong/gout/encoder"
 	"github.com/guonaihong/gout/middler"
 	"github.com/guonaihong/gout/setting"
 )
@@ -31,7 +32,7 @@ type Req struct {
 	wwwForm []interface{}
 
 	// http body
-	bodyEncoder encode.Encoder
+	bodyEncoder encoder.Encoder
 	bodyDecoder []decode.Decoder
 
 	// http header

debug/debug.go

@@ -29,6 +29,7 @@ func ToBodyType(s string) color.BodyType {
 
 // Options Debug mode core data structure
 type Options struct {
+	EscapeHTML  bool
 	Write       io.Writer
 	Debug       bool
 	Color       bool
@@ -106,7 +107,7 @@ func (do *Options) debugPrint(req *http.Request, rsp *http.Response) error {
 		}
 
 		var r = io.Reader(b)
-		format := color.NewFormatEncoder(r, do.Color, ToBodyType(do.ReqBodyType))
+		format := color.NewFormatEncoder(r, do.Color, ToBodyType(do.ReqBodyType), do.EscapeHTML)
 		if format != nil {
 			r = format
 		}
@@ -126,7 +127,7 @@ func (do *Options) debugPrint(req *http.Request, rsp *http.Response) error {
 	fmt.Fprintf(w, "\r\n\r\n")
 	// write rsp body
 	var r = io.Reader(rsp.Body)
-	format := color.NewFormatEncoder(r, do.Color, ToBodyType(do.RspBodyType))
+	format := color.NewFormatEncoder(r, do.Color, ToBodyType(do.RspBodyType), do.EscapeHTML)
 	if format != nil {
 		r = format
 	}

encode/body.go

@@ -2,9 +2,11 @@ package encode
 
 import (
 	"fmt"
-	"github.com/guonaihong/gout/core"
 	"io"
 	"reflect"
+
+	"github.com/guonaihong/gout/core"
+	"github.com/guonaihong/gout/encoder"
 )
 
 // BodyEncode body encoder structure
@@ -13,7 +15,7 @@ type BodyEncode struct {
 }
 
 // NewBodyEncode create a new body encoder
-func NewBodyEncode(obj interface{}) Encoder {
+func NewBodyEncode(obj interface{}) encoder.Encoder {
 	if obj == nil {
 		return nil
 	}

encode/protobuf.go

@@ -5,6 +5,7 @@ import (
 	"io"
 
 	"github.com/guonaihong/gout/core"
+	"github.com/guonaihong/gout/encoder"
 	"google.golang.org/protobuf/proto"
 )
 
@@ -14,7 +15,7 @@ type ProtoBufEncode struct {
 	obj interface{}
 }
 
-func NewProtoBufEncode(obj interface{}) Encoder {
+func NewProtoBufEncode(obj interface{}) encoder.Encoder {
 	if nil == obj {
 		return nil
 	}

encode/xml.go

@@ -4,8 +4,10 @@ import (
 	"bytes"
 	"encoding/xml"
 	"errors"
-	"github.com/guonaihong/gout/core"
 	"io"
+
+	"github.com/guonaihong/gout/core"
+	"github.com/guonaihong/gout/encoder"
 )
 
 var ErrNotXML = errors.New("Not xml data")
@@ -16,7 +18,7 @@ type XMLEncode struct {
 }
 
 // NewXMLEncode create a new xml encoder
-func NewXMLEncode(obj interface{}) Encoder {
+func NewXMLEncode(obj interface{}) encoder.Encoder {
 	if obj == nil {
 		return nil
 	}

encode/yaml.go

@@ -5,6 +5,7 @@ import (
 	"io"
 
 	"github.com/guonaihong/gout/core"
+	"github.com/guonaihong/gout/encoder"
 	"gopkg.in/yaml.v2"
 )
 
@@ -16,7 +17,7 @@ type YAMLEncode struct {
 }
 
 // NewYAMLEncode create a new yaml encoder
-func NewYAMLEncode(obj interface{}) Encoder {
+func NewYAMLEncode(obj interface{}) encoder.Encoder {
 	if obj == nil {
 		return nil
 	}

encode/encoder.go → encoder/encoder.go

@@ -1,4 +1,4 @@
-package encode
+package encoder
 
 import (
 	"io"