github.com/cloudwego/hertz@v0.9.3/pkg/app/server/render/json.go (about)

     1  /*
     2   * Copyright 2022 CloudWeGo Authors
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *  http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   *
    16   * The MIT License (MIT)
    17   *
    18   * Copyright (c) 2014 Manuel Martínez-Almeida
    19   *
    20   * Permission is hereby granted, free of charge, to any person obtaining a copy
    21   * of this software and associated documentation files (the "Software"), to deal
    22   * in the Software without restriction, including without limitation the rights
    23   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    24   * copies of the Software, and to permit persons to whom the Software is
    25   * furnished to do so, subject to the following conditions:
    26   *
    27   * The above copyright notice and this permission notice shall be included in
    28   * all copies or substantial portions of the Software.
    29   *
    30   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    31   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    32   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    33   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    34   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    35   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    36   * THE SOFTWARE.
    37  
    38   * This file may have been modified by CloudWeGo authors. All CloudWeGo
    39   * Modifications are Copyright 2022 CloudWeGo Authors.
    40   */
    41  
    42  package render
    43  
    44  import (
    45  	"bytes"
    46  	"encoding/json"
    47  
    48  	hjson "github.com/cloudwego/hertz/pkg/common/json"
    49  	"github.com/cloudwego/hertz/pkg/protocol"
    50  )
    51  
    52  // JSONMarshaler customize json.Marshal as you like
    53  type JSONMarshaler func(v interface{}) ([]byte, error)
    54  
    55  var jsonMarshalFunc JSONMarshaler
    56  
    57  func init() {
    58  	ResetJSONMarshal(hjson.Marshal)
    59  }
    60  
    61  func ResetJSONMarshal(fn JSONMarshaler) {
    62  	jsonMarshalFunc = fn
    63  }
    64  
    65  func ResetStdJSONMarshal() {
    66  	ResetJSONMarshal(json.Marshal)
    67  }
    68  
    69  // JSONRender JSON contains the given interface object.
    70  type JSONRender struct {
    71  	Data interface{}
    72  }
    73  
    74  var jsonContentType = "application/json; charset=utf-8"
    75  
    76  // Render (JSON) writes data with custom ContentType.
    77  func (r JSONRender) Render(resp *protocol.Response) error {
    78  	writeContentType(resp, jsonContentType)
    79  	jsonBytes, err := jsonMarshalFunc(r.Data)
    80  	if err != nil {
    81  		return err
    82  	}
    83  
    84  	resp.AppendBody(jsonBytes)
    85  	return nil
    86  }
    87  
    88  // WriteContentType (JSON) writes JSON ContentType.
    89  func (r JSONRender) WriteContentType(resp *protocol.Response) {
    90  	writeContentType(resp, jsonContentType)
    91  }
    92  
    93  // PureJSON contains the given interface object.
    94  type PureJSON struct {
    95  	Data interface{}
    96  }
    97  
    98  // Render (JSON) writes data with custom ContentType.
    99  func (r PureJSON) Render(resp *protocol.Response) (err error) {
   100  	r.WriteContentType(resp)
   101  	buffer := new(bytes.Buffer)
   102  	encoder := json.NewEncoder(buffer)
   103  	encoder.SetEscapeHTML(false)
   104  	err = encoder.Encode(r.Data)
   105  	if err != nil {
   106  		return
   107  	}
   108  	resp.AppendBody(buffer.Bytes())
   109  	return
   110  }
   111  
   112  // WriteContentType (JSON) writes JSON ContentType.
   113  func (r PureJSON) WriteContentType(resp *protocol.Response) {
   114  	writeContentType(resp, jsonContentType)
   115  }
   116  
   117  // IndentedJSON contains the given interface object.
   118  type IndentedJSON struct {
   119  	Data interface{}
   120  }
   121  
   122  // Render (IndentedJSON) marshals the given interface object and writes it with custom ContentType.
   123  func (r IndentedJSON) Render(resp *protocol.Response) (err error) {
   124  	writeContentType(resp, jsonContentType)
   125  	jsonBytes, err := jsonMarshalFunc(r.Data)
   126  	if err != nil {
   127  		return err
   128  	}
   129  	var buf bytes.Buffer
   130  	err = json.Indent(&buf, jsonBytes, "", "    ")
   131  	if err != nil {
   132  		return err
   133  	}
   134  	resp.AppendBody(buf.Bytes())
   135  	return nil
   136  }
   137  
   138  // WriteContentType (JSON) writes JSON ContentType.
   139  func (r IndentedJSON) WriteContentType(resp *protocol.Response) {
   140  	writeContentType(resp, jsonContentType)
   141  }