本文是區塊鏈瀏覽器系列的第五篇,項目完整代碼在[這裡](https://github.com/mengbin92/browser/tree/main)。 在[上一篇文章](https://mengbin.top/2023-08-20-browser2/)中給瀏覽器增加了簡單的用戶認證,至此瀏覽器的基 ...
本文是區塊鏈瀏覽器系列的第五篇,項目完整代碼在這裡。
在上一篇文章中給瀏覽器增加了簡單的用戶認證,至此瀏覽器的基本功能就已經大致完成了。
在這片文章中,我將使用kratos對區塊鏈瀏覽器器進行重構,使之同時支持http和gRPC。
1. 項目結構
項目結構如下:
$ tree
.
├── api
│ └── browser
│ └── v1
│ ├── block_grpc.pb.go
│ ├── block_http.pb.go
│ ├── block.pb.go
│ ├── block.proto
│ ├── browser_grpc.pb.go
│ ├── browser_http.pb.go
│ ├── browser.pb.go
│ └── browser.proto
├── cmd
│ └── example
│ ├── main.go
│ ├── wire_gen.go
│ └── wire.go
├── configs
│ └── config.yaml
├── Dockerfile
├── go.mod
├── go.sum
├── internal
│ ├── biz
│ │ ├── account.go
│ │ ├── biz.go
│ │ ├── README.md
│ │ └── repo.go
│ ├── conf
│ │ ├── conf.pb.go
│ │ └── conf.proto
│ ├── data
│ │ ├── account.go
│ │ ├── data.go
│ │ └── README.md
│ ├── db
│ │ ├── db.go
│ │ ├── mysql
│ │ │ └── mysql.go
│ │ ├── pg
│ │ │ └── pg.go
│ │ └── sqlite3
│ │ └── sqlite3.go
│ ├── server
│ │ ├── grpc.go
│ │ ├── http.go
│ │ └── server.go
│ ├── service
│ │ ├── block.go
│ │ ├── browser.go
│ │ ├── global.go
│ │ ├── README.md
│ │ ├── service.go
│ │ └── utils.go
│ └── utils
│ ├── putils.go
│ └── utils.go
├── LICENSE
├── Makefile
├── openapi.yaml
├── README.md
└── third_party
├── errors
│ └── errors.proto
├── google
│ ├── api
│ │ ├── annotations.proto
│ │ ├── client.proto
│ │ ├── field_behavior.proto
│ │ ├── httpbody.proto
│ │ └── http.proto
│ └── protobuf
│ ├── any.proto
│ ├── api.proto
│ ├── compiler
│ │ └── plugin.proto
│ ├── descriptor.proto
│ ├── duration.proto
│ ├── empty.proto
│ ├── field_mask.proto
│ ├── source_context.proto
│ ├── struct.proto
│ ├── timestamp.proto
│ ├── type.proto
│ └── wrappers.proto
├── openapi
│ └── v3
│ ├── annotations.proto
│ └── openapi.proto
├── README.md
└── validate
├── README.md
└── validate.proto
26 directories, 66 files
api
定義介面block.prot
:區塊上傳和區塊解析的介面browser
:用戶認證相關介面,包括用戶註冊、用戶登錄以及刷新token
cmd
:本地調試使用,基於wire實現configs
:存放項目的配置文件internal
:業務邏輯實現biz
:類似DTO,封裝資料庫操作conf
:定義項目配置項data
:數據處理,目前主要是處理用戶認證相關數據db
:資料庫操作實現server
:註冊http和gRPC服務service
:實現瀏覽器業務邏輯utils
:工具類
third_party
:依賴的第三方庫,主要是protobuf相關的第三方庫
2. api介面定義
block.proto
中定義區塊上傳和解析操作:
syntax = "proto3";
package api.browser.v1;
option go_package = "mengbin92/browser/api/browser/v1;v1";
import "google/api/annotations.proto";
service Block {
rpc UpChaincode(UploadRequest) returns (UploadResponse) {
option (google.api.http) = {
post : "/v1/block/up"
body : "*"
};
};
rpc ParseBlock(ParseRequest) returns (ParseResponse) {
option (google.api.http) = {
get : "/v1/block/parse"
};
}
}
message UploadRequest {
string name = 1;
bytes content = 2;
}
message UploadResponse {
bool result = 1;
string name = 2;
}
message ParseRequest {
enum BlockOperation {
BLOCK = 0;
HEADER = 1;
DATA = 2;
CONFIG = 3;
CHAINCODE = 4;
ACTIONS = 5;
TRANSACTION = 6;
INPUT = 7;
RWSET = 8;
CHANNEL = 9;
ENDORSEMENTS = 10;
CREATOR = 11;
METADATA = 12;
}
string name = 1;
BlockOperation operation = 2;
}
message ParseResponse { bytes data = 1; }
message Endorser {
string MSP = 1;
string Name = 2;
}
message Endorsers { repeated Endorser endorsers = 1; }
browser.proto
定義用戶註冊、登錄和token刷新操作:
syntax = "proto3";
package api.browser.v1;
option go_package = "mengbin92/browser/api/browser/v1;v1";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
service Browser {
rpc GetToken(Login) returns (LoginResponse) {
option (google.api.http) = {
post : "/v1/user/login"
body : "*"
};
};
rpc Regisger(Login) returns (LoginResponse) {
option (google.api.http) = {
post : "/v1/user/register"
body : "*"
};
};
rpc RefreshToken(RefreshRequest) returns (LoginResponse) {
option (google.api.http) = {
get : "/v1/user/refresh/{id}"
};
};
}
message User {
uint64 id = 1;
string name = 2;
string password = 3;
string salt = 4;
google.protobuf.Timestamp create_at = 5;
google.protobuf.Timestamp update_at = 6;
google.protobuf.Timestamp delete_at = 7;
}
message LoginResponse {
string token = 1;
int64 expire = 2;
uint64 id = 3;
string username = 4;
}
message Login {
string username = 1;
string password = 2;
}
message RefreshRequest { uint64 id = 1; }
在項目根目錄下執行下麵命令即可完成框架生成:
# 生成對應的go文件
$ make api
# 生成service文件
$ kratos proto server api/browser/v1/block.proto -t internal/service
$ kratos proto server api/browser/v1/browser.proto -t internal/service
3. biz介紹
biz
定義了用戶認證相關的介面,供service
調用,介面內容如下:
type AccountRepo interface {
// 用戶註冊
Register(context.Context, string, string) (*v1.LoginResponse, error)
// 用戶登錄,用於獲取token
Login(context.Context, string, string) (*v1.LoginResponse, error)
// 刷新token
RefreshToken(context.Context, uint64) (*v1.LoginResponse, error)
}
4. conf介紹
conf
定義項目的配置項,也是通過protobuf定義的:
syntax = "proto3";
package browser.api;
option go_package = "mengbin92/browser/internal/conf;conf";
import "google/protobuf/duration.proto";
message Bootstrap {
Server server = 1;
Log log = 2;
Data data = 3;
}
message Server {
message HTTP {
string network = 1;
string addr = 2;
google.protobuf.Duration timeout = 3;
}
message GRPC {
string network = 1;
string addr = 2;
google.protobuf.Duration timeout = 3;
}
enum AuthType{
TOKENAUTH = 0;
BASICAUTH = 1;
NOAUTH = 2;
}
HTTP http = 1;
GRPC grpc = 2;
TLS tls = 3;
// 2: no auth; 1: basic auth; default: 0, token auth
AuthType auth_type = 4;
Auth auth = 5;
}
message TLS {
// 是否啟用tls
bool enbale = 1;
// 證書路徑
string cert = 2;
// 對應私鑰路徑
string key = 3;
}
message Log {
// 日誌級別設置
// 支持debug(-1)、info(0)、warn(1)、error(2)、dpanic(3)、panic(4)、fatal(5)
int32 level = 1;
// 日誌輸出格式,支持json or console
string format = 2;
}
message Database {
// 資料庫類型:mysql、sqlite3、postgres
string driver = 1;
string source = 2;
// 最大空閑連接數
int64 max_idle_conn = 3;
// 最大連接數
int64 max_open_conn = 4;
// 連接空閑超時參數
google.protobuf.Duration conn_max_lifetime = 5;
}
message Redis {
string network = 1;
string addr = 2;
string password = 3;
int32 db = 4;
google.protobuf.Duration dial_timeout = 5;
google.protobuf.Duration read_timeout = 6;
google.protobuf.Duration write_timeout = 7;
}
message Data {
Database database = 1;
Redis redis = 2;
}
message Auth {
// jwt 秘鑰,暫未啟用
string jwt_secret = 1;
// token過期時間
google.protobuf.Duration expire = 2;
}
5. data介紹
data
中定義了AccountRepo
結構,主要實現了biz
中與資料庫交互的業務邏輯:
type AccountRepo struct {
data *Data
log *log.Helper
jwtSecret string
expire time.Duration
}
func NewAccountRepo(data *Data, logger log.Logger, auth *conf.Auth) biz.AccountRepo {
return &AccountRepo{
data: data,
log: log.NewHelper(logger),
jwtSecret: auth.JwtSecret,
expire: auth.Expire.AsDuration(),
}
}
func genSalt() string {
uid, _ := uuid.NewRandom()
return uid.String()
}
func (ar *AccountRepo) Register(ctx context.Context, username, password string) (*v1.LoginResponse, error) {
salt := genSalt()
u := &User{
Name: username,
Password: utils.CalcPassword(password, salt),
Salt: salt,
}
if err := ar.data.db.Save(u).Error; err != nil {
ar.log.Errorf("save user data error: %s", err.Error())
return nil, errors.Wrap(err, "save user error")
}
now := time.Now()
tokenString, err := ar.genToken(uint64(u.ID), now)
if err != nil {
ar.log.Errorf("create token error: %s", err.Error())
return nil, errors.Wrap(err, "create token error")
}
return &v1.LoginResponse{
Token: tokenString,
Expire: now.Add(ar.expire).Unix(),
Id: uint64(u.ID),
Username: u.Name,
}, nil
}
func (ar *AccountRepo) Login(ctx context.Context, username, password string) (*v1.LoginResponse, error) {
user, err := ar.getUserByName(ctx, username)
if err != nil {
ar.log.Errorf("get user from data error: %s", err.Error())
return nil, errors.Wrap(err, "GetUserByName error")
}
if utils.CalcPassword(password, user.Salt) != user.Password {
ar.log.Error("user name or password is incorrect")
return nil, errors.New("user name or password is incorrect")
}
now := time.Now()
tokenString, err := ar.genToken(user.Id, now)
if err != nil {
ar.log.Errorf("create token error: %s", err.Error())
return nil, errors.Wrap(err, "create token error")
}
return &v1.LoginResponse{
Token: tokenString,
Expire: now.Add(ar.expire).Unix(),
Id: user.Id,
Username: user.Name,
}, nil
}
func (ar *AccountRepo) RefreshToken(ctx context.Context, id uint64) (*v1.LoginResponse, error) {
user, err := ar.getUserById(ctx, id)
if err != nil {
ar.log.Errorf("get user from data error: %s", err.Error())
return nil, errors.Wrap(err, "GetUserByName error")
}
now := time.Now()
tokenString, err := ar.genToken(user.Id, now)
if err != nil {
ar.log.Errorf("create token error: %s", err.Error())
return nil, errors.Wrap(err, "create token error")
}
return &v1.LoginResponse{
Token: tokenString,
Expire: now.Add(ar.expire).Unix(),
Id: user.Id,
Username: user.Name,
}, nil
}
6. service介紹
service
主要實現api
中定義的介面:
-
block.go
:type BlockService struct { pb.UnimplementedBlockServer } func NewBlockService() *BlockService { return &BlockService{} } func (s *BlockService) UpChaincode(ctx context.Context, req *pb.UploadRequest) (*pb.UploadResponse, error) { // 與gin實現版本類似,客戶端上傳區塊數據存儲到服務端 return &pb.UploadResponse{ Result: true, Name: req.Name, }, nil } func (s *BlockService) ParseBlock(ctx context.Context, req *pb.ParseRequest) (*pb.ParseResponse, error) { // 與gin實現版本邏輯類似,這裡就不再贅述了 return &pb.ParseResponse{}, nil }
-
browser.go
:type BrowserService struct { account *biz.AccountUsecase pb.UnimplementedBrowserServer } func NewBrowserService(repo *biz.AccountUsecase, logger klog.Logger) *BrowserService { log = klog.NewHelper(logger) return &BrowserService{ account: repo, } } func (s *BrowserService) GetToken(ctx context.Context, req *pb.Login) (*pb.LoginResponse, error) { return s.account.Login(ctx, req.Username, req.Password) } func (s *BrowserService) Regisger(ctx context.Context, req *pb.Login) (*pb.LoginResponse, error) { return s.account.Register(ctx, req.Username, req.Password) } func (s *BrowserService) RefreshToken(ctx context.Context, req *pb.RefreshRequest) (*pb.LoginResponse, error) { return s.account.RefreshToken(ctx, req.Id) }
聲明:本作品採用署名-非商業性使用-相同方式共用 4.0 國際 (CC BY-NC-SA 4.0)進行許可,使用時請註明出處。
Author: mengbin
blog: mengbin
Github: mengbin92
cnblogs: 戀水無意