用go设计开发一个自己的轻量级登录库/框架吧(项目维护篇) ...

用go设计开发一个自己的轻量级登录库/框架吧(项目维护篇)

本篇将开始讲讲开发库/框架的最开始阶段，也就是搭建一个项目
源码：weloe/token-go: a light login library (github.com)
项目结构

项目结构，不是上一篇所说的代码架构，而是分包，明确的分包更有助于我们的开发。本框架分包如下

1. ├─.github
2. │  └─workflows GitHub工作流
3. ├─auth        权限管理
4. ├─config        配置
5. ├─constant        常量
6. ├─ctx        web上下文
7. │  └─go-http-context
8. ├─error       
9. ├─examples        使用示例
10. ├─log        日志
11. ├─model        模型
12. ├─persist        持久层
13. └─util 工具包

复制代码

代码托管以及自动化测试

我们选择使用GitHub进行代码托管，同时也使用GitHub Actions进行代码自动化测试。运行测试代码以及使用lint检查代码规范。
token-go/go.yml at master · weloe/token-go · GitHub

1. name: Go-Build-Test
3. on: [push, pull_request]
5. jobs:
7.   test:
8.     runs-on: ubuntu-latest
9.     strategy:
10.       matrix:
11.         go: [ '1.18', '1.19', '1.20' ]
12.     steps:
13.       - uses: actions/checkout@v2
15.       - name: Set up Go
16.         uses: actions/setup-go@v2
17.         with:
18.           go-version: ${{ matrix.go }}
20.       - name: Run go test
21.         run: go test -v ./...
23.   benchmark:
24.     runs-on: ubuntu-latest
25.     strategy:
26.       matrix:
27.         go: [ '1.18' ]
28.     steps:
29.       - uses: actions/checkout@v2
31.       - name: Set up Go
32.         uses: actions/setup-go@v2
33.         with:
34.           go-version: ${{ matrix.go }}
36.       - name: Run go test bench
37.         run: go test -bench=.
39.   lint:
40.     runs-on: ubuntu-latest
41.     steps:
42.       - uses: actions/checkout@v2
44.       - name: Set up Go
45.         uses: actions/setup-go@v2
46.         with:
47.           go-version: '1.20'
49.       - name: golangci-lint
50.         uses: golangci/golangci-lint-action@v3
51.         with:
52.           version: v1.51

复制代码

测试

在进行代码开发的同时，我们也应该进行代码测试用例的编写，提高代码测试覆盖率，确保我们的代码的健壮性。

文档

文档可以说是一个开源库/框架必不可少的东西，我们开始学习一个开源库/框架也往往是从文档开始。我们可以使用Docsify，Vuepress等来快速搭建一个文档网站。关于如何搭建文档可以看看这篇随笔

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