Fabric区块链浏览器（3）

渣渣兔  金牌会员 | 2023-9-2 21:03:24 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 850|帖子 850|积分 2550

本文是区块链浏览器系列的第五篇，项目完整代码在这里。
在上一篇文章中给浏览器增加了简单的用户认证，至此浏览器的基本功能就已经大致完成了。
在这片文章中，我将使用kratos对区块链浏览器器进行重构，使之同时支持http和gRPC。
1. 项目结构

项目结构如下：
  1. $ tree
  2. .
  3. ├── api                                    
  4. │   └── browser
  5. │       └── v1
  6. │           ├── block_grpc.pb.go
  7. │           ├── block_http.pb.go
  8. │           ├── block.pb.go
  9. │           ├── block.proto
  10. │           ├── browser_grpc.pb.go
  11. │           ├── browser_http.pb.go
  12. │           ├── browser.pb.go
  13. │           └── browser.proto
  14. ├── cmd
  15. │   └── example
  16. │       ├── main.go
  17. │       ├── wire_gen.go
  18. │       └── wire.go
  19. ├── configs
  20. │   └── config.yaml
  21. ├── Dockerfile
  22. ├── go.mod
  23. ├── go.sum
  24. ├── internal
  25. │   ├── biz
  26. │   │   ├── account.go
  27. │   │   ├── biz.go
  28. │   │   ├── README.md
  29. │   │   └── repo.go
  30. │   ├── conf
  31. │   │   ├── conf.pb.go
  32. │   │   └── conf.proto
  33. │   ├── data
  34. │   │   ├── account.go
  35. │   │   ├── data.go
  36. │   │   └── README.md
  37. │   ├── db
  38. │   │   ├── db.go
  39. │   │   ├── mysql
  40. │   │   │   └── mysql.go
  41. │   │   ├── pg
  42. │   │   │   └── pg.go
  43. │   │   └── sqlite3
  44. │   │       └── sqlite3.go
  45. │   ├── server
  46. │   │   ├── grpc.go
  47. │   │   ├── http.go
  48. │   │   └── server.go
  49. │   ├── service
  50. │   │   ├── block.go
  51. │   │   ├── browser.go
  52. │   │   ├── global.go
  53. │   │   ├── README.md
  54. │   │   ├── service.go
  55. │   │   └── utils.go
  56. │   └── utils
  57. │       ├── putils.go
  58. │       └── utils.go
  59. ├── LICENSE
  60. ├── Makefile
  61. ├── openapi.yaml
  62. ├── README.md
  63. └── third_party
  64.     ├── errors
  65.     │   └── errors.proto
  66.     ├── google
  67.     │   ├── api
  68.     │   │   ├── annotations.proto
  69.     │   │   ├── client.proto
  70.     │   │   ├── field_behavior.proto
  71.     │   │   ├── httpbody.proto
  72.     │   │   └── http.proto
  73.     │   └── protobuf
  74.     │       ├── any.proto
  75.     │       ├── api.proto
  76.     │       ├── compiler
  77.     │       │   └── plugin.proto
  78.     │       ├── descriptor.proto
  79.     │       ├── duration.proto
  80.     │       ├── empty.proto
  81.     │       ├── field_mask.proto
  82.     │       ├── source_context.proto
  83.     │       ├── struct.proto
  84.     │       ├── timestamp.proto
  85.     │       ├── type.proto
  86.     │       └── wrappers.proto
  87.     ├── openapi
  88.     │   └── v3
  89.     │       ├── annotations.proto
  90.     │       └── openapi.proto
  91.     ├── README.md
  92.     └── validate
  93.         ├── README.md
  94.         └── validate.proto
  96. 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中定义区块上传和解析操作：
  1. syntax = "proto3";
  3. package api.browser.v1;
  5. option go_package = "mengbin92/browser/api/browser/v1;v1";
  7. import "google/api/annotations.proto";
  9. service Block {
  10.   rpc UpChaincode(UploadRequest) returns (UploadResponse) {
  11.     option (google.api.http) = {
  12.       post : "/v1/block/up"
  13.       body : "*"
  14.     };
  15.   };
  16.   rpc ParseBlock(ParseRequest) returns (ParseResponse) {
  17.     option (google.api.http) = {
  18.       get : "/v1/block/parse"
  19.     };
  20.   }
  21. }
  23. message UploadRequest {
  24.   string name = 1;
  25.   bytes content = 2;
  26. }
  28. message UploadResponse {
  29.   bool result = 1;
  30.   string name = 2;
  31. }
  33. message ParseRequest {
  34.   enum BlockOperation {
  35.     BLOCK = 0;
  36.     HEADER = 1;
  37.     DATA = 2;
  38.     CONFIG = 3;
  39.     CHAINCODE = 4;
  40.     ACTIONS = 5;
  41.     TRANSACTION = 6;
  42.     INPUT = 7;
  43.     RWSET = 8;
  44.     CHANNEL = 9;
  45.     ENDORSEMENTS = 10;
  46.     CREATOR = 11;
  47.     METADATA = 12;
  48.   }
  49.   string name = 1;
  50.   BlockOperation operation = 2;
  51. }
  53. message ParseResponse { bytes data = 1; }
  55. message Endorser {
  56.   string MSP = 1;
  57.   string Name = 2;
  58. }
  59. message Endorsers { repeated Endorser endorsers = 1; }
复制代码
browser.proto定义用户注册、登录和token刷新操作：
  1. syntax = "proto3";
  3. package api.browser.v1;
  5. option go_package = "mengbin92/browser/api/browser/v1;v1";
  7. import "google/protobuf/timestamp.proto";
  8. import "google/api/annotations.proto";
  10. service Browser {
  11.   rpc GetToken(Login) returns (LoginResponse) {
  12.     option (google.api.http) = {
  13.       post : "/v1/user/login"
  14.       body : "*"
  15.     };
  16.   };
  17.   rpc Regisger(Login) returns (LoginResponse) {
  18.     option (google.api.http) = {
  19.       post : "/v1/user/register"
  20.       body : "*"
  21.     };
  22.   };
  23.   rpc RefreshToken(RefreshRequest) returns (LoginResponse) {
  24.     option (google.api.http) = {
  25.       get : "/v1/user/refresh/{id}"
  26.     };
  27.   };
  28. }
  30. message User {
  31.   uint64 id = 1;
  32.   string name = 2;
  33.   string password = 3;
  34.   string salt = 4;
  35.   google.protobuf.Timestamp create_at = 5;
  36.   google.protobuf.Timestamp update_at = 6;
  37.   google.protobuf.Timestamp delete_at = 7;
  38. }
  40. message LoginResponse {
  41.   string token = 1;
  42.   int64 expire = 2;
  43.   uint64 id = 3;
  44.   string username = 4;
  45. }
  47. message Login {
  48.   string username = 1;
  49.   string password = 2;
  50. }
  52. message RefreshRequest { uint64 id = 1; }
复制代码
在项目根目录下执行下面命令即可完成框架生成：
  1. # 生成对应的go文件
  2. $ make api
  3. # 生成service文件
  4. $ kratos proto server api/browser/v1/block.proto -t internal/service
  5. $ kratos proto server api/browser/v1/browser.proto -t internal/service
复制代码
3. biz介绍

biz定义了用户认证相关的接口，供service调用，接口内容如下：
  1. type AccountRepo interface {
  2.     // 用户注册
  3.         Register(context.Context, string, string) (*v1.LoginResponse, error)
  4.     // 用户登录，用于获取token
  5.         Login(context.Context, string, string) (*v1.LoginResponse, error)
  6.     // 刷新token
  7.         RefreshToken(context.Context, uint64) (*v1.LoginResponse, error)
  8. }
复制代码
4. conf介绍

conf定义项目的配置项，也是通过protobuf定义的：
  1. syntax = "proto3";
  3. package browser.api;
  5. option go_package = "mengbin92/browser/internal/conf;conf";
  7. import "google/protobuf/duration.proto";
  9. message Bootstrap {
  10.   Server server = 1;
  11.   Log log = 2;
  12.   Data data = 3;
  13. }
  15. message Server {
  16.   message HTTP {
  17.     string network = 1;
  18.     string addr = 2;
  19.     google.protobuf.Duration timeout = 3;
  20.   }
  21.   message GRPC {
  22.     string network = 1;
  23.     string addr = 2;
  24.     google.protobuf.Duration timeout = 3;
  25.   }
  26.   enum AuthType{
  27.     TOKENAUTH = 0;
  28.     BASICAUTH = 1;
  29.     NOAUTH = 2;
  30.   }
  31.   HTTP http = 1;
  32.   GRPC grpc = 2;
  33.   TLS tls = 3;
  34.   // 2: no auth; 1: basic auth; default: 0, token auth
  35.   AuthType auth_type = 4;
  36.   Auth auth = 5;
  37. }
  39. message TLS {
  40.   // 是否启用tls
  41.   bool enbale = 1;
  42.   // 证书路径
  43.   string cert = 2;
  44.   // 对应私钥路径
  45.   string key = 3;
  46. }
  48. message Log {
  49.   // 日志级别设置
  50.   // 支持debug(-1)、info(0)、warn(1)、error(2)、dpanic(3)、panic(4)、fatal(5)
  51.   int32 level = 1;
  52.   // 日志输出格式，支持json or console
  53.   string format = 2;
  54. }
  56. message Database {
  57.   // 数据库类型：mysql、sqlite3、postgres
  58.   string driver = 1;
  59.   string source = 2;
  60.   // 最大空闲连接数
  61.   int64 max_idle_conn = 3;
  62.   // 最大连接数
  63.   int64 max_open_conn = 4;
  64.   // 连接空闲超时参数
  65.   google.protobuf.Duration conn_max_lifetime = 5;
  66. }
  67. message Redis {
  68.   string network = 1;
  69.   string addr = 2;
  70.   string password = 3;
  71.   int32 db = 4;
  72.   google.protobuf.Duration dial_timeout = 5;
  73.   google.protobuf.Duration read_timeout = 6;
  74.   google.protobuf.Duration write_timeout = 7;
  75. }
  77. message Data {
  78.   Database database = 1;
  79.   Redis redis = 2;
  80. }
  82. message Auth {
  83.   // jwt 秘钥，暂未启用
  84.   string jwt_secret = 1;
  85.   // token过期时间
  86.   google.protobuf.Duration expire = 2;
  87. }
复制代码
5. data介绍

data中定义了AccountRepo结构，主要实现了biz中与数据库交互的业务逻辑：
  1. type AccountRepo struct {
  2.         data      *Data
  3.         log       *log.Helper
  4.         jwtSecret string
  5.         expire    time.Duration
  6. }
  8. func NewAccountRepo(data *Data, logger log.Logger, auth *conf.Auth) biz.AccountRepo {
  9.         return &AccountRepo{
  10.                 data:      data,
  11.                 log:       log.NewHelper(logger),
  12.                 jwtSecret: auth.JwtSecret,
  13.                 expire:    auth.Expire.AsDuration(),
  14.         }
  15. }
  17. func genSalt() string {
  18.         uid, _ := uuid.NewRandom()
  19.         return uid.String()
  20. }
  22. func (ar *AccountRepo) Register(ctx context.Context, username, password string) (*v1.LoginResponse, error) {
  23.         salt := genSalt()
  24.         u := &User{
  25.                 Name:     username,
  26.                 Password: utils.CalcPassword(password, salt),
  27.                 Salt:     salt,
  28.         }
  29.         if err := ar.data.db.Save(u).Error; err != nil {
  30.                 ar.log.Errorf("save user data error: %s", err.Error())
  31.                 return nil, errors.Wrap(err, "save user error")
  32.         }
  34.         now := time.Now()
  35.         tokenString, err := ar.genToken(uint64(u.ID), now)
  36.         if err != nil {
  37.                 ar.log.Errorf("create token error: %s", err.Error())
  38.                 return nil, errors.Wrap(err, "create token error")
  39.         }
  41.         return &v1.LoginResponse{
  42.                 Token:    tokenString,
  43.                 Expire:   now.Add(ar.expire).Unix(),
  44.                 Id:       uint64(u.ID),
  45.                 Username: u.Name,
  46.         }, nil
  47. }
  48. func (ar *AccountRepo) Login(ctx context.Context, username, password string) (*v1.LoginResponse, error) {
  49.         user, err := ar.getUserByName(ctx, username)
  50.         if err != nil {
  51.                 ar.log.Errorf("get user from data error: %s", err.Error())
  52.                 return nil, errors.Wrap(err, "GetUserByName error")
  53.         }
  55.         if utils.CalcPassword(password, user.Salt) != user.Password {
  56.                 ar.log.Error("user name or password is incorrect")
  57.                 return nil, errors.New("user name or password is incorrect")
  58.         }
  59.         now := time.Now()
  60.         tokenString, err := ar.genToken(user.Id, now)
  61.         if err != nil {
  62.                 ar.log.Errorf("create token error: %s", err.Error())
  63.                 return nil, errors.Wrap(err, "create token error")
  64.         }
  66.         return &v1.LoginResponse{
  67.                 Token:    tokenString,
  68.                 Expire:   now.Add(ar.expire).Unix(),
  69.                 Id:       user.Id,
  70.                 Username: user.Name,
  71.         }, nil
  72. }
  73. func (ar *AccountRepo) RefreshToken(ctx context.Context, id uint64) (*v1.LoginResponse, error) {
  74.         user, err := ar.getUserById(ctx, id)
  75.         if err != nil {
  76.                 ar.log.Errorf("get user from data error: %s", err.Error())
  77.                 return nil, errors.Wrap(err, "GetUserByName error")
  78.         }
  80.         now := time.Now()
  81.         tokenString, err := ar.genToken(user.Id, now)
  82.         if err != nil {
  83.                 ar.log.Errorf("create token error: %s", err.Error())
  84.                 return nil, errors.Wrap(err, "create token error")
  85.         }
  87.         return &v1.LoginResponse{
  88.                 Token:    tokenString,
  89.                 Expire:   now.Add(ar.expire).Unix(),
  90.                 Id:       user.Id,
  91.                 Username: user.Name,
  92.         }, nil
  93. }
复制代码
6. service介绍

service主要实现api中定义的接口：

  • block.go：
    1. type BlockService struct {
    2.         pb.UnimplementedBlockServer
    3. }
    5. func NewBlockService() *BlockService {
    6.         return &BlockService{}
    7. }
    9. func (s *BlockService) UpChaincode(ctx context.Context, req *pb.UploadRequest) (*pb.UploadResponse, error) {
    10.     // 与gin实现版本类似，客户端上传区块数据存储到服务端
    11.         return &pb.UploadResponse{
    12.                 Result: true,
    13.                 Name:   req.Name,
    14.         }, nil
    15. }
    16. func (s *BlockService) ParseBlock(ctx context.Context, req *pb.ParseRequest) (*pb.ParseResponse, error) {
    17.     // 与gin实现版本逻辑类似，这里就不再赘述了
    18.         return &pb.ParseResponse{}, nil
    19. }
    复制代码
  • browser.go：
    1. type BrowserService struct {
    2.         account *biz.AccountUsecase
    3.         pb.UnimplementedBrowserServer
    4. }
    6. func NewBrowserService(repo *biz.AccountUsecase, logger klog.Logger) *BrowserService {
    7.         log = klog.NewHelper(logger)
    8.         return &BrowserService{
    9.                 account: repo,
    10.         }
    11. }
    13. func (s *BrowserService) GetToken(ctx context.Context, req *pb.Login) (*pb.LoginResponse, error) {
    14.         return s.account.Login(ctx, req.Username, req.Password)
    15. }
    16. func (s *BrowserService) Regisger(ctx context.Context, req *pb.Login) (*pb.LoginResponse, error) {
    17.         return s.account.Register(ctx, req.Username, req.Password)
    18. }
    19. func (s *BrowserService) RefreshToken(ctx context.Context, req *pb.RefreshRequest) (*pb.LoginResponse, error) {
    20.         return s.account.RefreshToken(ctx, req.Id)
    21. }
    复制代码
  
声明：本作品采用署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)进行许可，使用时请注明出处。
Author: mengbin
blog: mengbin
Github: mengbin92
cnblogs: 恋水无意

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

渣渣兔

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

存储 挺好的 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表