mirror of
https://gitee.com/johng/gf
synced 2026-06-06 02:25:47 +08:00
db9f47d942
This pull request refactors the error handling code to improve support for error text formatting with arguments, making it easier to retrieve both the error message template and its arguments (useful for i18n and structured error handling). It introduces the new `ITextArgs` interface, updates error constructors to store format strings and arguments separately, and adds methods to retrieve them. Several usages and tests are updated to reflect these changes. ### Error formatting and argument support * Introduced the `ITextArgs` interface to allow errors to expose their text template and arguments separately, supporting advanced use cases like internationalization (`errors/gerror/gerror.go`). * Updated the `Error` struct to include an `args` field for error arguments, and added methods `TextWithArgs()`, `Text()`, and `Args()` to retrieve formatted error text, the template, and arguments respectively (`errors/gerror/gerror_error.go`). [[1]](diffhunk://#diff-b56b52e546735b8196ec3e8bd25c0b007ac134e2f13b116ee3abcb2f92c3bdd9R23) [[2]](diffhunk://#diff-b56b52e546735b8196ec3e8bd25c0b007ac134e2f13b116ee3abcb2f92c3bdd9L121-R145) * Changed all error creation and wrapping functions (e.g., `Newf`, `Wrapf`, `NewCodef`, etc.) to store the format string and arguments separately, rather than pre-formatting the error text (`errors/gerror/gerror_api.go`, `errors/gerror/gerror_api_code.go`). [[1]](diffhunk://#diff-847475c1de42114004c50163aa2f34a4095e05122b4c2993aa3df4e5923e83cbL24-R27) [[2]](diffhunk://#diff-847475c1de42114004c50163aa2f34a4095e05122b4c2993aa3df4e5923e83cbL43-R48) [[3]](diffhunk://#diff-847475c1de42114004c50163aa2f34a4095e05122b4c2993aa3df4e5923e83cbL77-R78) [[4]](diffhunk://#diff-31ee6b1493f4b206c060a98818226b1b78102c91b5ae22e34ed4d1bb4a38c185L25-R29) [[5]](diffhunk://#diff-31ee6b1493f4b206c060a98818226b1b78102c91b5ae22e34ed4d1bb4a38c185L44-R50) [[6]](diffhunk://#diff-31ee6b1493f4b206c060a98818226b1b78102c91b5ae22e34ed4d1bb4a38c185L77-R79) [[7]](diffhunk://#diff-31ee6b1493f4b206c060a98818226b1b78102c91b5ae22e34ed4d1bb4a38c185L107-R110) * Updated the `Option` struct and related constructor to handle error arguments (`errors/gerror/gerror_api_option.go`). [[1]](diffhunk://#diff-4b458af6df9a0d8289303cf408b082ed472360b286cdc5a556c8fe7541973caaR16) [[2]](diffhunk://#diff-4b458af6df9a0d8289303cf408b082ed472360b286cdc5a556c8fe7541973caaR26) ### Code and test improvements * Updated formatting and equality checks to use the new methods for retrieving formatted error text and arguments, ensuring consistent behavior (`errors/gerror/gerror_error.go`, `errors/gerror/gerror_error_format.go`). [[1]](diffhunk://#diff-b56b52e546735b8196ec3e8bd25c0b007ac134e2f13b116ee3abcb2f92c3bdd9L45-R46) [[2]](diffhunk://#diff-fa801ef307f6c6fdda49fe9853593de29eda5b4d3712ea5bf9ed39de6e6859ebL26-R26) * Improved unit tests to verify the new interface and argument handling, including tests for the `ITextArgs` interface (`errors/gerror/gerror_z_unit_test.go`). * Minor code cleanup, such as removing unused imports and updating comments for clarity (`errors/gerror/gerror_api.go`, `errors/gerror/gerror_api_code.go`, `errors/gerror/gerror_error_json.go`). [[1]](diffhunk://#diff-847475c1de42114004c50163aa2f34a4095e05122b4c2993aa3df4e5923e83cbL10-L11) [[2]](diffhunk://#diff-31ee6b1493f4b206c060a98818226b1b78102c91b5ae22e34ed4d1bb4a38c185L10) [[3]](diffhunk://#diff-3e4ba207e242eb338f31f1091466374e8e72754a8969d92724bfb5c6b88f25edL15-R15) These changes make error handling more flexible and maintainable, especially for scenarios where error messages need to be localized or programmatically inspected. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
18 lines
514 B
Go
18 lines
514 B
Go
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
|
//
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
// If a copy of the MIT was not distributed with this file,
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
package gerror
|
|
|
|
import (
|
|
"encoding/json"
|
|
)
|
|
|
|
// MarshalJSON implements the interface json.Marshaler for Error.
|
|
// It serializes the error using its string representation.
|
|
func (err *Error) MarshalJSON() ([]byte, error) {
|
|
return json.Marshal(err.Error())
|
|
}
|