Skip to content

feat(net/ghttp): add AutoDecodingBody configuration for ghttp.Server #4197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 71 additions & 7 deletions net/ghttp/ghttp_request_param.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"bytes"
"fmt"
"io"
"mime"
"mime/multipart"
"net/http"
"reflect"
Expand Down Expand Up @@ -233,22 +234,46 @@ func (r *Request) parseBody() {
if r.ContentLength == 0 {
return
}
// If it's a multipart request, it does not parse the body content.
contentType := r.Header.Get("Content-Type")
if gstr.Contains(contentType, "multipart/") {
return
}

// Skip binary content types, which should not be parsed.
if r.isBinaryContentType(contentType) {
return
}

if body := r.GetBody(); len(body) > 0 {
// Trim space/new line characters.
body = bytes.TrimSpace(body)
// JSON format checks.
if body[0] == '{' && body[len(body)-1] == '}' {

// json/xml content type checks.
if gstr.Contains(contentType, "/json") {
_ = json.UnmarshalUseNumber(body, &r.bodyMap)
return
}
// XML format checks.
if len(body) > 5 && bytes.EqualFold(body[:5], xmlHeaderBytes) {
if gstr.Contains(contentType, "/xml") {
r.bodyMap, _ = gxml.DecodeWithoutRoot(body)
Copy link
Preview

Copilot AI Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After decoding XML in the AutoDecodingBody block, consider adding a return statement to prevent falling through to the default decoding logic, which may inadvertently override the XML decoding result.

Copilot uses AI. Check for mistakes.

return
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

保留错误应该会更好?

}
if body[0] == '<' && body[len(body)-1] == '>' {
r.bodyMap, _ = gxml.DecodeWithoutRoot(body)
// Auto decoding body content.
if r.Server.config.AutoDecodingBody {
// JSON format checks.
if body[0] == '{' && body[len(body)-1] == '}' {
_ = json.UnmarshalUseNumber(body, &r.bodyMap)
}
// XML format checks.
if len(body) > 5 && bytes.EqualFold(body[:5], xmlHeaderBytes) {
r.bodyMap, _ = gxml.DecodeWithoutRoot(body)
}
if body[0] == '<' && body[len(body)-1] == '>' {
r.bodyMap, _ = gxml.DecodeWithoutRoot(body)
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

为什么后面两个if不是else if

}
// Default parameters decoding.
if contentType := r.Header.Get("Content-Type"); (contentType == "" || !gstr.Contains(contentType, "multipart/")) && r.bodyMap == nil {
if r.bodyMap == nil {
r.bodyMap, _ = gstr.Parse(r.GetBodyString())
}
}
Expand Down Expand Up @@ -383,3 +408,42 @@ func (r *Request) GetMultipartFiles(name string) []*multipart.FileHeader {
}
return nil
}

// isBinaryContentType check the content type is binary or not.
func (r *Request) isBinaryContentType(contentType string) bool {
// parseMediaType
mimeType, _, err := mime.ParseMediaType(contentType)
// If the content type is invalid, it's treated as binary.
if err != nil {
return true
}

// Lowercase the MIME type for easier comparison
mimeType = strings.ToLower(mimeType)

// if the MIME type is text, then it's definitely not binary
if strings.HasPrefix(mimeType, "text/") {
return false
}

// defined non-binary MIME types
nonBinaryTypes := map[string]struct{}{
"application/json": {},
"application/xml": {},
"application/x-www-form-urlencoded": {},
"application/javascript": {},
"application/xhtml+xml": {},
}
if _, ok := nonBinaryTypes[mimeType]; ok {
return false
}

// if the MIME type is JSON or XML, it's definitely not binary
if strings.HasSuffix(mimeType, "+json") || strings.HasSuffix(mimeType, "+xml") {
return false
}

// otherwise, it's binary
// (this includes application/octet-stream、image/*、video/*、audio/*)
return true
}
6 changes: 5 additions & 1 deletion net/ghttp/ghttp_server_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ type ServerConfig struct {
// Logging.
// ======================================================================================================

Logger *glog.Logger `json:"logger"` // Logger specifies the logger for server.
Logger *glog.Logger `json:"logger"` // Logger directly specifies the logger for server.
LogPath string `json:"logPath"` // LogPath specifies the directory for storing logging files.
LogLevel string `json:"logLevel"` // LogLevel specifies the logging level for logger.
LogStdout bool `json:"logStdout"` // LogStdout specifies whether printing logging content to stdout.
Expand Down Expand Up @@ -267,6 +267,9 @@ type ServerConfig struct {

// DumpRouterMap specifies whether automatically dumps router map when server starts.
DumpRouterMap bool `json:"dumpRouterMap"`

// AutoDecodingBody specifies whether automatically decodes request body using common encoding types: json/xml.
AutoDecodingBody bool `json:"auto_decoding_body"`
}

// NewConfig creates and returns a ServerConfig object with default configurations.
Expand Down Expand Up @@ -313,6 +316,7 @@ func NewConfig() ServerConfig {
Graceful: false,
GracefulTimeout: 2, // seconds
GracefulShutdownTimeout: 5, // seconds
AutoDecodingBody: true,
}
}

Expand Down
Loading