-
Notifications
You must be signed in to change notification settings - Fork 3
/
error.go
executable file
·163 lines (151 loc) · 5.47 KB
/
error.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
// Package errorKit
/*
极客时间的"Go error处理最佳实践": https://u.geekbang.org/lesson/376?article=513711
输出带有堆栈的error时,建议使用: logrusKit.PrintError 或 logrusKit.PrintErrorWithLogger.
使用时的注意点:
(a) 在应用代码(业务代码)中,使用 errorKit.Newf 返回错误;
(b) 在项目工程里面,如果调用其它包内的函数,通常简单的直接返回error,即向上抛;
(c) 如果和其它库(第三方库、标准库)进行协作,考虑使用 errorKit.Wrapf 保存堆栈信息;
(d) 不要到处打日志(比如每个错误产生的地方),直接往上抛的情况不需要打日志;
(e) 在 程序的顶部 或 工作的goroutine顶部(请求入口),使用 %+v 输出堆栈详情.
(f) 使用 errorKit.Cause 获取root error,再和sentinel error判定.
(g) 如果你的函数不打算处理这个错误,你没法处理,那么应该携带上足够多的上下文,然后往上抛;(Wrapf errors)
(h) 如果错误被处理了,那么它就不应该被往上抛并且记日志,
如果是 第三方库 或 基础库(被很多人使用并且是跨很多项目的),
(a) 应该返回 root error,它的原始错误是什么就是什么;
(b) 如果返回的新的error,应该使用 errorKit.Simple 来创建error;
(c) errorKit.Newf、errorKit.Wrapf 和 errorKit.WithMessage: 业务代码可以使用,第三方库和基础库不应该使用(以避免保存多次堆栈信息,太冗余了);
*/
package errorKit
//// Simple 新建error(指针;不会携带堆栈信息)
//func Simple(format string, args ...interface{}) error {
// format = funcKit.GetEntireCaller(2) + " " + format
//
// return errors.Newf(fmt.Sprintf(format, args...))
//}
//// SimpleWithExtraSkip
///*
//@param extraSkip 额外跳过的层数(>= 0)
//*/
//func SimpleWithExtraSkip(extraSkip int, format string, args ...interface{}) error {
// format = funcKit.GetEntireCaller(2+extraSkip) + " " + format
//
// return errors.Newf(fmt.Sprintf(format, args...))
//}
//// Newf 新建error(指针;会携带堆栈信息)
///*
//e.g. 返回值为什么是指针(详见 errors.Errorf)
// err := errorKit.Newf("123")
// err1 := errorKit.Newf("123")
// fmt.Println(err == err) // true
// fmt.Println(err == err1) // false(因为内存地址不一样)
//*/
//func Newf(format string, args ...interface{}) error {
// format = funcKit.GetEntireCaller(2) + " " + format
//
// return errors2.Errorf(format, args...)
//}
//
//// NewWithExtraSkip
///*
//@param extraSkip 额外跳过的层数
//*/
//func NewWithExtraSkip(extraSkip int, format string, args ...interface{}) error {
// format = funcKit.GetEntireCaller(2+extraSkip) + " " + format
//
// return errors2.Errorf(format, args...)
//}
//// IsErrorWithStack 错误是否有堆栈信息?
///*
//不考虑复杂情况(e.g. 混用 errorKit.Wrapf 和 errorKit.WithMessage),
// errorKit.Wrapf 和 errorKit.Newf 返回的error(非nil),将返回: true;
// errorKit.WithMessage 返回的error(非nil),将返回: false.
//
//e.g.
//err := io.EOF
//err1 := errorKit.Wrapf(io.EOF, "1")
//err2 := errorKit.WithMessage(io.EOF, "2")
//err3 := errorKit.Newf("3")
//
//fmt.Println(errorKit.IsErrorWithStack(err)) // false
//fmt.Println(errorKit.IsErrorWithStack(err1)) // true
//fmt.Println(errorKit.IsErrorWithStack(err2)) // false
//fmt.Println(errorKit.IsErrorWithStack(err3)) // true
//*/
//func IsErrorWithStack(err error) bool {
// type stackTracer interface {
// StackTrace() errors2.StackTrace
// }
//
// if err == nil {
// return false
// }
// _, ok := err.(stackTracer)
// return ok
//}
//func WithStack(err error) error {
// return errors2.WithStack(err)
//}
//// Wrapf
///*
//Wrapf returns an error annotating err with a stack trace at the point Wrapf is called, and the supplied message.
//If err is nil, Wrapf returns nil.
//
//@param format 建议首字母小写,且最后面不要加标点符号,否则"%v"输出会比较难看(%v: message在左边;%+v: message在下边)
//*/
//func Wrapf(err error, format string, args ...interface{}) error {
// format = funcKit.GetEntireCaller(2) + " " + format
//
// return errors2.Wrapf(err, format, args...)
//}
//// WithMessage
///*
//WithMessage annotates err with a new message.
//If err is nil, WithMessage returns nil.
//%v: message在左边;
//%+v: message在下面。
//
//e.g.
// var err error = redis.Nil
// err = errorKit.WithMessage(err, "message")
//
// //test/test2.go:11|main message: redis: nil
// fmt.Printf("%v\n", err)
//
// //redis: nil
// //test/test2.go:11|main message
// fmt.Printf("%+v\n", err)
//*/
//func WithMessage(err error, format string, args ...interface{}) error {
// format = funcKit.GetEntireCaller(2) + " " + format
//
// return errors2.WithMessagef(err, format, args...)
//}
//// WithLocationInfo 附带调用此方法的caller的信息
///*
//e.g.
// err := io.EOF
// err = errorKit.WithLocationInfo(err)
//
// // test/test1.go:11|main: EOF
// fmt.Printf("%v\n", err)
//
// // EOF
// // test/test1.go:11|main
// fmt.Printf("%+v\n", err)
//*/
//func WithLocationInfo(err error) error {
// info := funcKit.GetEntireCaller(2)
// return errors2.WithMessage(err, info)
//}
//// Cause 获取传参err的root error(错误的根因).
///*
//(1) If the error does not implement Cause, the original error will be returned.(返回最原始的错误)
//(2) If the error is nil, nil will be returned without further investigation.
//
//e.g.
//(nil) => nil
//*/
//func Cause(err error) error {
// return errors2.Cause(err)
//}