github_mirrors/go-zero
1
0
Fork 0
mirror of https://github.com/zeromicro/go-zero.git synced 2025-01-23 09:00:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor: move json related header vars to internal (#1840)

Browse Source 
* refactor: move json related header vars to internal

* refactor: use header.ContentType
This commit is contained in:
Kevin Wan 2022-04-28 15:12:04 +08:00 committed by GitHub
parent cef83efd4e
commit 3bbc90ec24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 58 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/stat/remotewriter.go
View File

@ -39,7 +39,7 @@ func (rw *RemoteWriter) Write(report *StatReport) error {
client := &http.Client{
Timeout: httpTimeout,
}
resp, err := client.Post(rw.endpoint, jsonContentType, bytes.NewBuffer(bs))
resp, err := client.Post(rw.endpoint, jsonContentType, bytes.NewReader(bs))
if err != nil {
return err
}

3
rest/httpc/requests.go
View File

@ -13,6 +13,7 @@ import (
"github.com/zeromicro/go-zero/core/lang"
"github.com/zeromicro/go-zero/core/mapping"
"github.com/zeromicro/go-zero/rest/httpc/internal"
"github.com/zeromicro/go-zero/rest/internal/header"
)
var interceptors = []internal.Interceptor{
@ -98,7 +99,7 @@ func buildRequest(ctx context.Context, method, url string, data interface{}) (*h
req.URL.RawQuery = buildFormQuery(u, val[formKey])
fillHeader(req, val[headerKey])
if hasJsonBody {
req.Header.Set(contentType, applicationJson)
req.Header.Set(header.ContentType, header.JsonContentType)
}
return req, nil

3
rest/httpc/requests_test.go
View File

@ -8,6 +8,7 @@ import (
"github.com/stretchr/testify/assert"
"github.com/zeromicro/go-zero/rest/httpx"
"github.com/zeromicro/go-zero/rest/internal/header"
"github.com/zeromicro/go-zero/rest/router"
)
@ -27,7 +28,7 @@ func TestDoRequest_NotFound(t *testing.T) {
defer svr.Close()
req, err := http.NewRequest(http.MethodPost, svr.URL, nil)
assert.Nil(t, err)
req.Header.Set("Content-Type", "application/json")
req.Header.Set(header.ContentType, header.JsonContentType)
resp, err := DoRequest(req)
assert.Nil(t, err)
assert.Equal(t, http.StatusNotFound, resp.StatusCode)

3
rest/httpc/responses.go
View File

@ -6,6 +6,7 @@ import (
"github.com/zeromicro/go-zero/core/mapping"
"github.com/zeromicro/go-zero/rest/internal/encoding"
"github.com/zeromicro/go-zero/rest/internal/header"
)
// Parse parses the response.
@ -32,5 +33,5 @@ func ParseJsonBody(resp *http.Response, val interface{}) error {
}
func withJsonBody(r *http.Response) bool {
return r.ContentLength > 0 && strings.Contains(r.Header.Get(contentType), applicationJson)
return r.ContentLength > 0 && strings.Contains(r.Header.Get(header.ContentType), header.ApplicationJson)
}

7
rest/httpc/responses_test.go
View File

@ -6,6 +6,7 @@ import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/zeromicro/go-zero/rest/internal/header"
)
func TestParse(t *testing.T) {
@ -16,7 +17,7 @@ func TestParse(t *testing.T) {
}
svr := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("foo", "bar")
w.Header().Set(contentType, applicationJson)
w.Header().Set(header.ContentType, header.JsonContentType)
w.Write([]byte(`{"name":"kevin","value":100}`))
}))
defer svr.Close()
@ -36,7 +37,7 @@ func TestParseHeaderError(t *testing.T) {
}
svr := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("foo", "bar")
w.Header().Set(contentType, applicationJson)
w.Header().Set(header.ContentType, header.JsonContentType)
}))
defer svr.Close()
req, err := http.NewRequest(http.MethodGet, svr.URL, nil)
@ -52,7 +53,7 @@ func TestParseNoBody(t *testing.T) {
}
svr := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("foo", "bar")
w.Header().Set(contentType, applicationJson)
w.Header().Set(header.ContentType, header.JsonContentType)
}))
defer svr.Close()
req, err := http.NewRequest(http.MethodGet, svr.URL, nil)

3
rest/httpc/service_test.go
View File

@ -7,6 +7,7 @@ import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/zeromicro/go-zero/rest/internal/header"
)
func TestNamedService_DoRequest(t *testing.T) {
@ -43,7 +44,7 @@ func TestNamedService_DoRequestPost(t *testing.T) {
service := NewService("foo")
req, err := http.NewRequest(http.MethodPost, svr.URL, nil)
assert.Nil(t, err)
req.Header.Set("Content-Type", "application/json")
req.Header.Set(header.ContentType, header.JsonContentType)
resp, err := service.DoRequest(req)
assert.Nil(t, err)
assert.Equal(t, http.StatusNotFound, resp.StatusCode)

14
rest/httpc/vars.go
View File

@ -3,14 +3,12 @@ package httpc
import "errors"
const (
pathKey = "path"
formKey = "form"
headerKey = "header"
jsonKey = "json"
slash = "/"
colon = ':'
contentType = "Content-Type"
applicationJson = "application/json; charset=utf-8"
pathKey = "path"
formKey = "form"
headerKey = "header"
jsonKey = "json"
slash = "/"
colon = ':'
)
// ErrGetWithBody indicates that GET request with body.

3
rest/httpx/requests.go
View File

@ -7,6 +7,7 @@ import (
"github.com/zeromicro/go-zero/core/mapping"
"github.com/zeromicro/go-zero/rest/internal/encoding"
"github.com/zeromicro/go-zero/rest/internal/header"
"github.com/zeromicro/go-zero/rest/pathvar"
)
@ -114,5 +115,5 @@ func ParsePath(r *http.Request, v interface{}) error {
}
func withJsonBody(r *http.Request) bool {
return r.ContentLength > 0 && strings.Contains(r.Header.Get(ContentType), ApplicationJson)
return r.ContentLength > 0 && strings.Contains(r.Header.Get(header.ContentType), header.ApplicationJson)
}

7
rest/httpx/requests_test.go
View File

@ -8,6 +8,7 @@ import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/zeromicro/go-zero/rest/internal/header"
"github.com/zeromicro/go-zero/rest/pathvar"
)
@ -204,7 +205,7 @@ func TestParseJsonBody(t *testing.T) {
body := `{"name":"kevin", "age": 18}`
r := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(body))
r.Header.Set(ContentType, ApplicationJson)
r.Header.Set(ContentType, header.JsonContentType)
assert.Nil(t, Parse(r, &v))
assert.Equal(t, "kevin", v.Name)
@ -267,7 +268,7 @@ func TestParseHeaders(t *testing.T) {
request.Header.Add("addrs", "addr2")
request.Header.Add("X-Forwarded-For", "10.0.10.11")
request.Header.Add("x-real-ip", "10.0.11.10")
request.Header.Add("Accept", "application/json")
request.Header.Add("Accept", header.JsonContentType)
err = ParseHeaders(request, &v)
if err != nil {
t.Fatal(err)
@ -277,7 +278,7 @@ func TestParseHeaders(t *testing.T) {
assert.Equal(t, []string{"addr1", "addr2"}, v.Addrs)
assert.Equal(t, "10.0.10.11", v.XForwardedFor)
assert.Equal(t, "10.0.11.10", v.XRealIP)
assert.Equal(t, "application/json", v.Accept)
assert.Equal(t, header.JsonContentType, v.Accept)
}
func TestParseHeaders_Error(t *testing.T) {

3
rest/httpx/responses.go
View File

@ -6,6 +6,7 @@ import (
"sync"
"github.com/zeromicro/go-zero/core/logx"
"github.com/zeromicro/go-zero/rest/internal/header"
)
var (
@ -67,7 +68,7 @@ func WriteJson(w http.ResponseWriter, code int, v interface{}) {
return
}
w.Header().Set(ContentType, ApplicationJson)
w.Header().Set(ContentType, header.JsonContentType)
w.WriteHeader(code)
if n, err := w.Write(bs); err != nil {

8
rest/httpx/vars.go
View File

@ -1,14 +1,16 @@
package httpx
import "github.com/zeromicro/go-zero/rest/internal/header"
const (
// ApplicationJson means application/json.
ApplicationJson = "application/json; charset=utf-8"
// ContentEncoding means Content-Encoding.
ContentEncoding = "Content-Encoding"
// ContentSecurity means X-Content-Security.
ContentSecurity = "X-Content-Security"
// ContentType means Content-Type.
ContentType = "Content-Type"
ContentType = header.ContentType
// JsonContentType means application/json.
JsonContentType = header.JsonContentType
// KeyField means key.
KeyField = "key"
// SecretField means secret.

10
rest/internal/header/headers.go Normal file
View File

@ -0,0 +1,10 @@
package header
const (
// ApplicationJson stands for application/json.
ApplicationJson = "application/json"
// ContentType is the header key for Content-Type.
ContentType = "Content-Type"
// JsonContentType is the content type for JSON.
JsonContentType = "application/json; charset=utf-8"
)

32
rest/router/patrouter_test.go
View File

@ -11,13 +11,11 @@ import (
"github.com/stretchr/testify/assert"
"github.com/zeromicro/go-zero/rest/httpx"
"github.com/zeromicro/go-zero/rest/internal/header"
"github.com/zeromicro/go-zero/rest/pathvar"
)
const (
applicationJsonWithUtf8 = "application/json; charset=utf-8"
contentLength = "Content-Length"
)
const contentLength = "Content-Length"
type mockedResponseWriter struct {
code int
@ -167,7 +165,7 @@ func TestParseJsonPost(t *testing.T) {
r, err := http.NewRequest(http.MethodPost, "http://hello.com/kevin/2017?nickname=whatever&zipcode=200000",
bytes.NewBufferString(`{"location": "shanghai", "time": 20170912}`))
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, httpx.ApplicationJson)
r.Header.Set(httpx.ContentType, httpx.JsonContentType)
router := NewRouter()
err = router.Handle(http.MethodPost, "/:name/:year", http.HandlerFunc(func(
@ -199,7 +197,7 @@ func TestParseJsonPostWithIntSlice(t *testing.T) {
r, err := http.NewRequest(http.MethodPost, "http://hello.com/kevin/2017",
bytes.NewBufferString(`{"ages": [1, 2], "years": [3, 4]}`))
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, httpx.ApplicationJson)
r.Header.Set(httpx.ContentType, httpx.JsonContentType)
router := NewRouter()
err = router.Handle(http.MethodPost, "/:name/:year", http.HandlerFunc(func(
@ -227,7 +225,7 @@ func TestParseJsonPostError(t *testing.T) {
r, err := http.NewRequest(http.MethodPost, "http://hello.com/kevin/2017?nickname=whatever&zipcode=200000",
bytes.NewBufferString(payload))
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, httpx.ApplicationJson)
r.Header.Set(httpx.ContentType, httpx.JsonContentType)
router := NewRouter()
err = router.Handle(http.MethodPost, "/:name/:year", http.HandlerFunc(
@ -255,7 +253,7 @@ func TestParseJsonPostInvalidRequest(t *testing.T) {
r, err := http.NewRequest(http.MethodPost, "http://hello.com/",
bytes.NewBufferString(payload))
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, httpx.ApplicationJson)
r.Header.Set(httpx.ContentType, httpx.JsonContentType)
router := NewRouter()
err = router.Handle(http.MethodPost, "/", http.HandlerFunc(
@ -277,7 +275,7 @@ func TestParseJsonPostRequired(t *testing.T) {
r, err := http.NewRequest(http.MethodPost, "http://hello.com/kevin/2017",
bytes.NewBufferString(`{"location": "shanghai"`))
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, httpx.ApplicationJson)
r.Header.Set(httpx.ContentType, httpx.JsonContentType)
router := NewRouter()
err = router.Handle(http.MethodPost, "/:name/:year", http.HandlerFunc(
@ -455,7 +453,7 @@ func TestParsePtrInRequest(t *testing.T) {
r, err := http.NewRequest(http.MethodPost, "http://hello.com/kevin/2017",
bytes.NewBufferString(`{"audio": {"volume": 100}}`))
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, httpx.ApplicationJson)
r.Header.Set(httpx.ContentType, httpx.JsonContentType)
type (
Request struct {
@ -603,7 +601,7 @@ func TestParseWrappedRequest(t *testing.T) {
func TestParseWrappedGetRequestWithJsonHeader(t *testing.T) {
r, err := http.NewRequest(http.MethodGet, "http://hello.com/kevin/2017", nil)
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, applicationJsonWithUtf8)
r.Header.Set(httpx.ContentType, header.JsonContentType)
type (
Request struct {
@ -636,7 +634,7 @@ func TestParseWrappedGetRequestWithJsonHeader(t *testing.T) {
func TestParseWrappedHeadRequestWithJsonHeader(t *testing.T) {
r, err := http.NewRequest(http.MethodHead, "http://hello.com/kevin/2017", nil)
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, applicationJsonWithUtf8)
r.Header.Set(httpx.ContentType, header.JsonContentType)
type (
Request struct {
@ -702,7 +700,7 @@ func TestParseWithAll(t *testing.T) {
r, err := http.NewRequest(http.MethodPost, "http://hello.com/kevin/2017?nickname=whatever&zipcode=200000",
bytes.NewBufferString(`{"location": "shanghai", "time": 20170912}`))
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, httpx.ApplicationJson)
r.Header.Set(httpx.ContentType, httpx.JsonContentType)
router := NewRouter()
err = router.Handle(http.MethodPost, "/:name/:year", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
@ -733,7 +731,7 @@ func TestParseWithAllUtf8(t *testing.T) {
r, err := http.NewRequest(http.MethodPost, "http://hello.com/kevin/2017?nickname=whatever&zipcode=200000",
bytes.NewBufferString(`{"location": "shanghai", "time": 20170912}`))
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, applicationJsonWithUtf8)
r.Header.Set(httpx.ContentType, header.JsonContentType)
router := NewRouter()
err = router.Handle(http.MethodPost, "/:name/:year", http.HandlerFunc(
@ -923,7 +921,7 @@ func TestParseWithMissingAllPaths(t *testing.T) {
func TestParseGetWithContentLengthHeader(t *testing.T) {
r, err := http.NewRequest(http.MethodGet, "http://hello.com/kevin/2017?nickname=whatever&zipcode=200000", nil)
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, httpx.ApplicationJson)
r.Header.Set(httpx.ContentType, header.JsonContentType)
r.Header.Set(contentLength, "1024")
router := NewRouter()
@ -951,7 +949,7 @@ func TestParseJsonPostWithTypeMismatch(t *testing.T) {
r, err := http.NewRequest(http.MethodPost, "http://hello.com/kevin/2017?nickname=whatever&zipcode=200000",
bytes.NewBufferString(`{"time": "20170912"}`))
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, applicationJsonWithUtf8)
r.Header.Set(httpx.ContentType, header.JsonContentType)
router := NewRouter()
err = router.Handle(http.MethodPost, "/:name/:year", http.HandlerFunc(
@ -977,7 +975,7 @@ func TestParseJsonPostWithInt2String(t *testing.T) {
r, err := http.NewRequest(http.MethodPost, "http://hello.com/kevin/2017",
bytes.NewBufferString(`{"time": 20170912}`))
assert.Nil(t, err)
r.Header.Set(httpx.ContentType, applicationJsonWithUtf8)
r.Header.Set(httpx.ContentType, header.JsonContentType)
router := NewRouter()
err = router.Handle(http.MethodPost, "/:name/:year", http.HandlerFunc(

2
tools/goctl/api/dartgen/vars.go
View File

@ -149,7 +149,7 @@ Future _apiRequest(String method, String path, dynamic data,
r = await client.getUrl(Uri.parse('https://' + serverHost + path));
}
r.headers.set('Content-Type', 'application/json');
r.headers.set('Content-Type', 'application/json; charset=utf-8');
if (tokens != null) {
r.headers.set('Authorization', tokens.accessToken);
}