完善常用错误快捷方式

Author: FishGoddess

HISTORY.md

@@ -1,5 +1,11 @@
 ## ✒ 历史版本的特性介绍 (Features in old versions)
 
+### v0.6.2-alpha
+
+> 此版本发布于 2024-08-10
+
+* 完善常用错误快捷方式
+
 ### v0.6.1-alpha
 
 > 此版本发布于 2024-08-10

README.en.md

@@ -27,28 +27,40 @@ import (
 
 func main() {
 	// Use wrap function to create an *Error error which has code and message.
+	// You can get code and message of err anytime.
 	err := errors.Wrap(1000, "need login")
 	fmt.Println(err)
-
-	// You can get code and message of err anytime.
 	fmt.Println(err.Code(), err.Message())
 
 	// Try these ways to get code and message!
 	// You will get default code or message if err doesn't have a code or message.
-	fmt.Println(errors.Code(err, 6699), errors.Message(err, "default message"))
-	fmt.Println(errors.Code(io.EOF, 6699), errors.Message(io.EOF, "default message"))
+	code := errors.Code(err, 6699)
+	message := errors.Message(err, "default message")
+	fmt.Println(code, message)
+
+	code = errors.Code(io.EOF, 6699)
+	message = errors.Message(io.EOF, "default message")
+	fmt.Println(code, message)
 
 	// Also, we provide some useful information carrier for you.
+	// For examples, you can carry an error or caller information.
 	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller()
 	fmt.Println(err)
+	fmt.Println(errors.CodeMessage(err, 6666, "default message"))
 
 	// What's more, we provide some shortcuts for you.
-	// All these ways are returning a *Error and you are free to use all methods on *Error.
+	// All these ways are returning *Error and you are free to use all methods on *Error.
 	berr := errors.BadRequest("id is wrong")
 	ferr := errors.Forbidden("user isn't allowed")
 	nerr := errors.NotFound("book not found")
 	rerr := errors.RequireLogin("user requires login")
 	fmt.Printf("%+v\n%+v\n%+v\n%+v\n", berr, ferr, nerr, rerr)
+
+	isBadRequest := errors.MatchBadRequest(berr)
+	isForbidden := errors.MatchForbidden(ferr)
+	isNotFound := errors.MatchNotFound(nerr)
+	isRequireLogin := errors.MatchRequireLogin(rerr)
+	fmt.Printf("isBadRequest: %+v\nisForbidden: %+v\nisNotFound: %+v\nisRequireLogin: %+v\n", isBadRequest, isForbidden, isNotFound, isRequireLogin)
 }
 
 ```

README.md

@@ -27,28 +27,40 @@ import (
 
 func main() {
 	// Use wrap function to create an *Error error which has code and message.
+	// You can get code and message of err anytime.
 	err := errors.Wrap(1000, "need login")
 	fmt.Println(err)
-
-	// You can get code and message of err anytime.
 	fmt.Println(err.Code(), err.Message())
 
 	// Try these ways to get code and message!
 	// You will get default code or message if err doesn't have a code or message.
-	fmt.Println(errors.Code(err, 6699), errors.Message(err, "default message"))
-	fmt.Println(errors.Code(io.EOF, 6699), errors.Message(io.EOF, "default message"))
+	code := errors.Code(err, 6699)
+	message := errors.Message(err, "default message")
+	fmt.Println(code, message)
+
+	code = errors.Code(io.EOF, 6699)
+	message = errors.Message(io.EOF, "default message")
+	fmt.Println(code, message)
 
 	// Also, we provide some useful information carrier for you.
+	// For examples, you can carry an error or caller information.
 	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller()
 	fmt.Println(err)
+	fmt.Println(errors.CodeMessage(err, 6666, "default message"))
 
 	// What's more, we provide some shortcuts for you.
-	// All these ways are returning a *Error and you are free to use all methods on *Error.
+	// All these ways are returning *Error and you are free to use all methods on *Error.
 	berr := errors.BadRequest("id is wrong")
 	ferr := errors.Forbidden("user isn't allowed")
 	nerr := errors.NotFound("book not found")
 	rerr := errors.RequireLogin("user requires login")
 	fmt.Printf("%+v\n%+v\n%+v\n%+v\n", berr, ferr, nerr, rerr)
+
+	isBadRequest := errors.MatchBadRequest(berr)
+	isForbidden := errors.MatchForbidden(ferr)
+	isNotFound := errors.MatchNotFound(nerr)
+	isRequireLogin := errors.MatchRequireLogin(rerr)
+	fmt.Printf("isBadRequest: %+v\nisForbidden: %+v\nisNotFound: %+v\nisRequireLogin: %+v\n", isBadRequest, isForbidden, isNotFound, isRequireLogin)
 }
 
 ```

_examples/basic.go

@@ -13,26 +13,38 @@ import (
 
 func main() {
 	// Use wrap function to create an *Error error which has code and message.
+	// You can get code and message of err anytime.
 	err := errors.Wrap(1000, "need login")
 	fmt.Println(err)
-
-	// You can get code and message of err anytime.
 	fmt.Println(err.Code(), err.Message())
 
 	// Try these ways to get code and message!
 	// You will get default code or message if err doesn't have a code or message.
-	fmt.Println(errors.Code(err, 6699), errors.Message(err, "default message"))
-	fmt.Println(errors.Code(io.EOF, 6699), errors.Message(io.EOF, "default message"))
+	code := errors.Code(err, 6699)
+	message := errors.Message(err, "default message")
+	fmt.Println(code, message)
+
+	code = errors.Code(io.EOF, 6699)
+	message = errors.Message(io.EOF, "default message")
+	fmt.Println(code, message)
 
 	// Also, we provide some useful information carrier for you.
+	// For examples, you can carry an error or caller information.
 	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller()
 	fmt.Println(err)
+	fmt.Println(errors.CodeMessage(err, 6666, "default message"))
 
 	// What's more, we provide some shortcuts for you.
-	// All these ways are returning a *Error and you are free to use all methods on *Error.
+	// All these ways are returning *Error and you are free to use all methods on *Error.
 	berr := errors.BadRequest("id is wrong")
 	ferr := errors.Forbidden("user isn't allowed")
 	nerr := errors.NotFound("book not found")
 	rerr := errors.RequireLogin("user requires login")
 	fmt.Printf("%+v\n%+v\n%+v\n%+v\n", berr, ferr, nerr, rerr)
+
+	isBadRequest := errors.MatchBadRequest(berr)
+	isForbidden := errors.MatchForbidden(ferr)
+	isNotFound := errors.MatchNotFound(nerr)
+	isRequireLogin := errors.MatchRequireLogin(rerr)
+	fmt.Printf("isBadRequest: %+v\nisForbidden: %+v\nisNotFound: %+v\nisRequireLogin: %+v\n", isBadRequest, isForbidden, isNotFound, isRequireLogin)
 }

types.go

@@ -5,24 +5,48 @@
 package errors
 
 const (
-	CodeBadRequest   = 400
-	CodeForbidden    = 403
-	CodeNotFound     = 404
-	CodeRequireLogin = 1000
+	codeBadRequest   = 400
+	codeForbidden    = 403
+	codeNotFound     = 404
+	codeRequireLogin = 1000
 )
 
+// BadRequest returns *Error with bad request code.
 func BadRequest(message string) *Error {
-	return Wrap(CodeBadRequest, message)
+	return Wrap(codeBadRequest, message)
 }
 
+// Forbidden returns *Error with forbidden code.
 func Forbidden(message string) *Error {
-	return Wrap(CodeForbidden, message)
+	return Wrap(codeForbidden, message)
 }
 
+// NotFound returns *Error with not found code.
 func NotFound(message string) *Error {
-	return Wrap(CodeNotFound, message)
+	return Wrap(codeNotFound, message)
 }
 
+// RequireLogin returns *Error with require login code.
 func RequireLogin(message string) *Error {
-	return Wrap(CodeRequireLogin, message)
+	return Wrap(codeRequireLogin, message)
+}
+
+// MatchBadRequest matches err with bad request code.
+func MatchBadRequest(err error) bool {
+	return Match(err, codeBadRequest)
+}
+
+// MatchForbidden matches err with forbidden code.
+func MatchForbidden(err error) bool {
+	return Match(err, codeForbidden)
+}
+
+// MatchNotFound matches err with not found code.
+func MatchNotFound(err error) bool {
+	return Match(err, codeNotFound)
+}
+
+// MatchRequireLogin matches err with require login code.
+func MatchRequireLogin(err error) bool {
+	return Match(err, codeRequireLogin)
 }

types_test.go

@@ -13,8 +13,8 @@ func TestBadRequest(t *testing.T) {
 		code    int32
 	}{
 		{
-			message: "id is nil",
-			code:    CodeBadRequest,
+			message: "xxx",
+			code:    codeBadRequest,
 		},
 	}
 
@@ -33,8 +33,8 @@ func TestForbidden(t *testing.T) {
 		code    int32
 	}{
 		{
-			message: "id is nil",
-			code:    CodeForbidden,
+			message: "xxx",
+			code:    codeForbidden,
 		},
 	}
 
@@ -53,8 +53,8 @@ func TestNotFound(t *testing.T) {
 		code    int32
 	}{
 		{
-			message: "id is nil",
-			code:    CodeNotFound,
+			message: "xxx",
+			code:    codeNotFound,
 		},
 	}
 
@@ -73,8 +73,8 @@ func TestRequireLogin(t *testing.T) {
 		code    int32
 	}{
 		{
-			message: "id is nil",
-			code:    CodeRequireLogin,
+			message: "xxx",
+			code:    codeRequireLogin,
 		},
 	}
 
@@ -85,3 +85,75 @@ func TestRequireLogin(t *testing.T) {
 		}
 	}
 }
+
+// go test -v -cover -count=1 -test.cpu=1 -run=^TestMatchBadRequest$
+func TestMatchBadRequest(t *testing.T) {
+	testCases := []struct {
+		message string
+	}{
+		{
+			message: "xxx",
+		},
+	}
+
+	for _, testCase := range testCases {
+		err := BadRequest(testCase.message)
+		if !MatchBadRequest(err) {
+			t.Errorf("err %+v not match code %d", err, err.Code())
+		}
+	}
+}
+
+// go test -v -cover -count=1 -test.cpu=1 -run=^TestMatchForbidden$
+func TestMatchForbidden(t *testing.T) {
+	testCases := []struct {
+		message string
+	}{
+		{
+			message: "xxx",
+		},
+	}
+
+	for _, testCase := range testCases {
+		err := Forbidden(testCase.message)
+		if !MatchForbidden(err) {
+			t.Errorf("err %+v not match code %d", err, err.Code())
+		}
+	}
+}
+
+// go test -v -cover -count=1 -test.cpu=1 -run=^TestMatchNotFound$
+func TestMatchNotFound(t *testing.T) {
+	testCases := []struct {
+		message string
+	}{
+		{
+			message: "xxx",
+		},
+	}
+
+	for _, testCase := range testCases {
+		err := NotFound(testCase.message)
+		if !MatchNotFound(err) {
+			t.Errorf("err %+v not match code %d", err, err.Code())
+		}
+	}
+}
+
+// go test -v -cover -count=1 -test.cpu=1 -run=^TestMatchRequireLogin$
+func TestMatchRequireLogin(t *testing.T) {
+	testCases := []struct {
+		message string
+	}{
+		{
+			message: "xxx",
+		},
+	}
+
+	for _, testCase := range testCases {
+		err := RequireLogin(testCase.message)
+		if !MatchRequireLogin(err) {
+			t.Errorf("err %+v not match code %d", err, err.Code())
+		}
+	}
+}