# README

项目简介

metadata 用于储存各种元信息

code错误码一般被用来进行异常传递，且需要具有携带message文案信息的能力。

在这里，错误码被设计成Codes接口，声明如下：

// 错误代码接口,其中包含代码和消息.
type Codes interface {
    // 有时错误返回字符串形式的代码
    // 注意：请勿在监控器报告中使用“error”,即使它现在也可以使用
    Error() string
    // 获取错误代码.
    Code() int
    // 获取错误信息.
    Message() string
    // 获取错误详细信息,可能为nil.
    Details() []interface{}
}

// Code是int型错误代码规范.
type Code int

可以看到该接口一共有四个方法，且type Code int结构体实现了该接口。

注册message

一个Code错误码可以对应一个message，默认实现会从全局变量_messages中获取，业务可以将自定义Code对应的message通过调用Register方法的方式传递进去，如：

cms := map[int]string{
    0: "很好很强大！",
    -304: "啥都没变啊~",
    -404: "啥都没有啊~",
}
metacode.Register(cms)

fmt.Println(metacode.OK.Message()) // 输出：很好很强大！

注意：map[int]string类型并不是绝对，比如有业务要支持多语言的场景就可以扩展为类似map[int]LangStruct的结构，因为全局变量_messages是atomic.Value类型，只需要修改对应的Message方法实现即可。

Details

Details接口为gRrc预留，gRrc传递异常会将服务端的错误码pb序列化之后赋值给Details，客户端拿到之后反序列化得到，具体可阅读status的实现：

code包内的Status结构体实现了Codes接口
grpc/status包内包装了metacode.Status和grpc.Status进行互相转换的方法
grpc的client和server则使用转换方法将gRrc底层返回的error最终转换为metacode.Status

转换为code

错误码转换有以下两种情况：

因为框架传递错误是靠code错误码，比如mvc框架返回的code字段默认就是数字，那么客户端接收到如{"code":-404}的话，可以使用mc := metacode.Int(-404)或mc := metacode.String("-404")来进行转换。
在项目中dao层返回一个错误码，往往返回参数类型建议为error而不是metacode.Codes，因为error更通用，那么上层service就可以使用mc := metacode.Cause(err)进行转换。

判断

错误码判断是否相等：

code与code判断使用：metacode.Equal(mc1, mc2)
code与error判断使用：metacode.EqualError(mc, err)

使用工具生成

使用proto协议定义错误码，格式如下：

// user.proto
syntax = "proto3";

package code;

enum UserErrCode { 
  UserUndefined = 0; // 因protobuf协议限制必须存在！！！无意义的0，工具生成代码时会忽略该参数
  UserNotLogin = 123; // 正式错误码
}

需要注意以下几点：