Skip to content

Commit 0b1cc91

Browse files
SliverHornSliverHorn
committed
service层注释规范化
1 parent 829fa4d commit 0b1cc91

21 files changed

+467
-513
lines changed

‎server/api/v1/exa_simple_uploader.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import (
1515
// @Security ApiKeyAuth
1616
// @accept multipart/form-data
1717
// @Produce application/json
18-
// TODO @Param file formData file true "断点续传插件版示例"
18+
// @Param file formData file true "断点续传插件版示例"
1919
// @Success 200 {string} string "{"success":true,"data":{},"msg":"切片创建成功"}"
2020
// @Router /simpleUploader/upload [post]
2121
func SimpleUploaderUpload(c *gin.Context) {

‎server/api/v1/sys_auto_code.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import (
1818
// @Security ApiKeyAuth
1919
// @accept application/json
2020
// @Produce application/json
21-
// TODO @Param data body model.AutoCodeStruct true "创建自动代码"
21+
// @Param data body model.AutoCodeStruct true "创建自动代码"
2222
// @Success 200 {string} string "{"success":true,"data":{},"msg":"创建成功"}"
2323
// @Router /autoCode/createTemp [post]
2424
func CreateTemp(c *gin.Context) {

‎server/api/v1/sys_operation_record.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ func DeleteSysOperationRecordByIds(c *gin.Context) {
6262
_ = c.ShouldBindJSON(&IDS)
6363
if err := service.DeleteSysOperationRecordByIds(IDS); err != nil {
6464
global.GVA_LOG.Error("批量删除失败!", zap.Any("err", err))
65-
6665
response.FailWithMessage("批量删除失败", c)
6766
} else {
6867
response.OkWithMessage("批量删除成功", c)

‎server/service/exa_breakpoint_continue.go‎

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,11 @@ import (
77
"gorm.io/gorm"
88
)
99

10-
// @title FindOrCreateFile
11-
// @description Check your file if it does not exist, or return current slice of the file
12-
// 上传文件时检测当前文件属性，如果没有文件则创建，有则返回文件的当前切片
13-
// @auth （2020/04/05 20:22）
14-
// @param fileMd5 string
15-
// @param fileName string
16-
// @param chunkTotal int
17-
// @return err error
18-
// @return file ExaFile
10+
//@author: [piexlmax](https://github.com/piexlmax)
11+
//@function: FindOrCreateFile
12+
//@description: 上传文件时检测当前文件属性，如果没有文件则创建，有则返回文件的当前切片
13+
//@param: fileMd5 string, fileName string, chunkTotal int
14+
//@return: err error, file model.ExaFile
1915

2016
func FindOrCreateFile(fileMd5 string, fileName string, chunkTotal int) (err error, file model.ExaFile) {
2117
var cfile model.ExaFile
@@ -33,13 +29,11 @@ func FindOrCreateFile(fileMd5 string, fileName string, chunkTotal int) (err erro
3329
return err, cfile
3430
}
3531

36-
// @title CreateFileChunk
37-
// @description create a chunk of the file, 创建文件切片记录
38-
// @auth （2020/04/05 20:22）
39-
// @param id unit
40-
// @param fileChunkPath string
41-
// @param fileChunkNumber int
42-
// @return error
32+
//@author: [piexlmax](https://github.com/piexlmax)
33+
//@function: CreateFileChunk
34+
//@description: 创建文件切片记录
35+
//@param: id uint, fileChunkPath string, fileChunkNumber int
36+
//@return: error
4337

4438
func CreateFileChunk(id uint, fileChunkPath string, fileChunkNumber int) error {
4539
var chunk model.ExaFileChunk
@@ -50,13 +44,11 @@ func CreateFileChunk(id uint, fileChunkPath string, fileChunkNumber int) error {
5044
return err
5145
}
5246

53-
// @title DeleteFileChunk
54-
// @description delete a chuck of the file, 删除文件切片记录
55-
// @auth （2020/04/05 20:22）
56-
// @param FileMd5 string
57-
// @param FileName string
58-
// @param FilePath string
59-
// @return error
47+
//@author: [piexlmax](https://github.com/piexlmax)
48+
//@function: DeleteFileChunk
49+
//@description: 删除文件切片记录
50+
//@param: fileMd5 string, fileName string, filePath string
51+
//@return: error
6052

6153
func DeleteFileChunk(fileMd5 string, fileName string, filePath string) error {
6254
var chunks []model.ExaFileChunk

‎server/service/exa_customer.go‎

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,57 +6,55 @@ import (
66
"gin-vue-admin/model/request"
77
)
88

9-
// @title CreateExaCustomer
10-
// @description create a customer, 创建用户
11-
// @param e model.ExaCustomer
12-
// @auth （2020/04/05 20:22）
13-
// @return err error
9+
//@author: [piexlmax](https://github.com/piexlmax)
10+
//@function: CreateExaCustomer
11+
//@description: 创建客户
12+
//@param: e model.ExaCustomer
13+
//@return: err error
1414

1515
func CreateExaCustomer(e model.ExaCustomer) (err error) {
1616
err = global.GVA_DB.Create(&e).Error
1717
return err
1818
}
1919

20-
// @title DeleteFileChunk
21-
// @description delete a customer, 删除用户
22-
// @auth （2020/04/05 20:22）
23-
// @param e model.ExaCustomer
24-
// @return error
20+
//@author: [piexlmax](https://github.com/piexlmax)
21+
//@function: DeleteFileChunk
22+
//@description: 删除客户
23+
//@param: e model.ExaCustomer
24+
//@return: err error
2525

2626
func DeleteExaCustomer(e model.ExaCustomer) (err error) {
2727
err = global.GVA_DB.Delete(e).Error
2828
return err
2929
}
3030

31-
// @title UpdateExaCustomer
32-
// @description update a customer, 更新用户
33-
// @param e *model.ExaCustomer
34-
// @auth （2020/04/05 20:22）
35-
// @return error
31+
//@author: [piexlmax](https://github.com/piexlmax)
32+
//@function: UpdateExaCustomer
33+
//@description: 更新客户
34+
//@param: e *model.ExaCustomer
35+
//@return: err error
3636

3737
func UpdateExaCustomer(e *model.ExaCustomer) (err error) {
3838
err = global.GVA_DB.Save(e).Error
3939
return err
4040
}
4141

42-
// @title GetExaCustomer
43-
// @description get the info of a costumer , 获取用户信息
44-
// @auth （2020/04/05 20:22）
45-
// @param id uint
46-
// @return error
47-
// @return customer ExaCustomer
42+
//@author: [piexlmax](https://github.com/piexlmax)
43+
//@function: GetExaCustomer
44+
//@description: 获取客户信息
45+
//@param: id uint
46+
//@return: err error, customer model.ExaCustomer
4847

4948
func GetExaCustomer(id uint) (err error, customer model.ExaCustomer) {
5049
err = global.GVA_DB.Where("id = ?", id).First(&customer).Error
5150
return
5251
}
5352

54-
// @title GetCustomerInfoList
55-
// @description get customer list by pagination, 分页获取用户列表
56-
// @auth （2020/04/05 20:22）
57-
// @param sysUserAuthorityID string
58-
// @param info PageInfo
59-
// @return error
53+
//@author: [piexlmax](https://github.com/piexlmax)
54+
//@function: GetCustomerInfoList
55+
//@description: 分页获取客户列表
56+
//@param: sysUserAuthorityID string, info request.PageInfo
57+
//@return: err error, list interface{}, total int64
6058

6159
func GetCustomerInfoList(sysUserAuthorityID string, info request.PageInfo) (err error, list interface{}, total int64) {
6260
limit := info.PageSize

‎server/service/exa_file_upload_download.go‎

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,33 @@ import (
1010
"strings"
1111
)
1212

13-
// @title Upload
14-
// @description 创建文件上传记录
15-
// @param file model.ExaFileUploadAndDownload
16-
// @auth （2020/04/05 20:22）
17-
// @return error
13+
//@author: [piexlmax](https://github.com/piexlmax)
14+
//@function: Upload
15+
//@description: 创建文件上传记录
16+
//@param: file model.ExaFileUploadAndDownload
17+
//@return: error
1818

1919
func Upload(file model.ExaFileUploadAndDownload) error {
20-
err := global.GVA_DB.Create(&file).Error
21-
return err
20+
return global.GVA_DB.Create(&file).Error
2221
}
2322

24-
// @title FindFile
25-
// @description 删除文件切片记录
26-
// @auth （2020/04/05 20:22）
27-
// @param id uint
28-
// @return error
23+
//@author: [piexlmax](https://github.com/piexlmax)
24+
//@function: FindFile
25+
//@description: 删除文件切片记录
26+
//@param: id uint
27+
//@return: error, model.ExaFileUploadAndDownload
2928

3029
func FindFile(id uint) (error, model.ExaFileUploadAndDownload) {
3130
var file model.ExaFileUploadAndDownload
3231
err := global.GVA_DB.Where("id = ?", id).First(&file).Error
3332
return err, file
3433
}
3534

36-
// @title DeleteFile
37-
// @description 删除文件记录
38-
// @auth （2020/04/05 20:22）
39-
// @param file model.ExaFileUploadAndDownload
40-
// @return error
35+
//@author: [piexlmax](https://github.com/piexlmax)
36+
//@function: DeleteFile
37+
//@description: 删除文件记录
38+
//@param: file model.ExaFileUploadAndDownload
39+
//@return: err error
4140

4241
func DeleteFile(file model.ExaFileUploadAndDownload) (err error) {
4342
var fileFromDb model.ExaFileUploadAndDownload
@@ -50,13 +49,11 @@ func DeleteFile(file model.ExaFileUploadAndDownload) (err error) {
5049
return err
5150
}
5251

53-
// @title GetFileRecordInfoList
54-
// @description 分页获取数据
55-
// @auth （2020/04/05 20:22）
56-
// @param info PageInfo
57-
// @return err error
58-
// @return list error
59-
// @return total error
52+
//@author: [piexlmax](https://github.com/piexlmax)
53+
//@function: GetFileRecordInfoList
54+
//@description: 分页获取数据
55+
//@param: info request.PageInfo
56+
//@return: err error, list interface{}, total int64
6057

6158
func GetFileRecordInfoList(info request.PageInfo) (err error, list interface{}, total int64) {
6259
limit := info.PageSize
@@ -68,13 +65,11 @@ func GetFileRecordInfoList(info request.PageInfo) (err error, list interface{},
6865
return err, fileLists, total
6966
}
7067

71-
// @title UploadFile
72-
// @description 根据配置文件判断是文件上传到本地或者七牛云
73-
// @auth （2020/04/05 20:22）
74-
// @param header *multipart.FileHeader
75-
// @param noSave string
76-
// @return err error
77-
// @return file file model.ExaFileUploadAndDownload
68+
//@author: [piexlmax](https://github.com/piexlmax)
69+
//@function: UploadFile
70+
//@description: 根据配置文件判断是文件上传到本地或者七牛云
71+
//@param: header *multipart.FileHeader, noSave string
72+
//@return: err error, file model.ExaFileUploadAndDownload
7873

7974
func UploadFile(header *multipart.FileHeader, noSave string) (err error, file model.ExaFileUploadAndDownload) {
8075
oss := upload.NewOss()

‎server/service/exa_simple_uploader.go‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,34 @@ import (
1111
"strconv"
1212
)
1313

14-
// 保存文件切片路径
14+
//@author: [piexlmax](https://github.com/piexlmax)
15+
//@function: SaveChunk
16+
//@description: 保存文件切片路径
17+
//@param: uploader model.ExaSimpleUploader
18+
//@return: err error
19+
1520
func SaveChunk(uploader model.ExaSimpleUploader) (err error) {
1621
return global.GVA_DB.Create(uploader).Error
1722
}
1823

19-
// 检查文件是否已经上传过
24+
//@author: [piexlmax](https://github.com/piexlmax)
25+
//@function: CheckFileMd5
26+
//@description: 检查文件是否已经上传过
27+
//@param: md5 string
28+
//@return: err error, uploads []model.ExaSimpleUploader, isDone bool
29+
2030
func CheckFileMd5(md5 string) (err error, uploads []model.ExaSimpleUploader, isDone bool) {
2131
err = global.GVA_DB.Find(&uploads, "identifier = ? AND is_done = ?", md5, false).Error
2232
isDone = errors.Is(global.GVA_DB.First(&model.ExaSimpleUploader{}, "identifier = ? AND is_done = ?", md5, true).Error, gorm.ErrRecordNotFound)
2333
return err, uploads, !isDone
2434
}
2535

26-
// 合并文件
36+
//@author: [piexlmax](https://github.com/piexlmax)
37+
//@function: MergeFileMd5
38+
//@description: 合并文件
39+
//@param: md5 string, fileName string
40+
//@return: err error
41+
2742
func MergeFileMd5(md5 string, fileName string) (err error) {
2843
finishDir := "./finish/"
2944
dir := "./chunk/" + md5

‎server/service/jwt_black_list.go‎

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,44 @@ import (
88
"time"
99
)
1010

11-
// @title JsonInBlacklist
12-
// @description create jwt blacklist
13-
// @param jwtList model.JwtBlacklist
14-
// @auth （2020/04/05 20:22）
15-
// @return err error
11+
//@author: [piexlmax](https://github.com/piexlmax)
12+
//@function: JsonInBlacklist
13+
//@description: 拉黑jwt
14+
//@param: jwtList model.JwtBlacklist
15+
//@return: err error
1616

1717
func JsonInBlacklist(jwtList model.JwtBlacklist) (err error) {
1818
err = global.GVA_DB.Create(&jwtList).Error
1919
return
2020
}
2121

22-
// @title IsBlacklist
23-
// @description check if the Jwt is in the blacklist or not, 判断JWT是否在黑名单内部
24-
// @auth （2020/04/05 20:22）
25-
// @param jwt string
26-
// @param jwtList model.JwtBlacklist
27-
// @return err error
22+
//@author: [piexlmax](https://github.com/piexlmax)
23+
//@function: IsBlacklist
24+
//@description: 判断JWT是否在黑名单内部
25+
//@param: jwt string
26+
//@return: bool
2827

2928
func IsBlacklist(jwt string) bool {
3029
isNotFound := errors.Is(global.GVA_DB.Where("jwt = ?", jwt).First(&model.JwtBlacklist{}).Error, gorm.ErrRecordNotFound)
3130
return !isNotFound
3231
}
3332

34-
// @title GetRedisJWT
35-
// @description Get user info in redis
36-
// @auth （2020/04/05 20:22）
37-
// @param userName string
38-
// @return err error
39-
// @return redisJWT string
33+
//@author: [piexlmax](https://github.com/piexlmax)
34+
//@function: GetRedisJWT
35+
//@description: 从redis取jwt
36+
//@param: userName string
37+
//@return: err error, redisJWT string
4038

4139
func GetRedisJWT(userName string) (err error, redisJWT string) {
4240
redisJWT, err = global.GVA_REDIS.Get(userName).Result()
4341
return err, redisJWT
4442
}
4543

46-
// @title SetRedisJWT
47-
// @description set jwt into the Redis
48-
// @auth （2020/04/05 20:22）
49-
// @param jwtList model.JwtBlacklist
50-
// @param userName string
51-
// @return err error
44+
//@author: [piexlmax](https://github.com/piexlmax)
45+
//@function: SetRedisJWT
46+
//@description: jwt存入redis并设置过期时间
47+
//@param: userName string
48+
//@return: err error, redisJWT string
5249

5350
func SetRedisJWT(jwt string, userName string) (err error) {
5451
// 此处过期时间等于jwt过期时间

0 commit comments

Comments
 (0)