add comment.

kk-cwh · Mar 24, 2019 · e466d3c · e466d3c
1 parent 4bfc659
commit e466d3c
Show file tree

Hide file tree

Showing 22 changed files with 81 additions and 35 deletions.
diff --git a/middleware/jwt/jwt.go b/middleware/jwt/jwt.go
@@ -10,6 +10,7 @@ import (
 	"github.com/EDDYCJY/go-gin-example/pkg/util"
 )
 
+// JWT is jwt middleware
 func JWT() gin.HandlerFunc {
 	return func(c *gin.Context) {
 		var code int

diff --git a/models/article.go b/models/article.go
@@ -17,6 +17,7 @@ type Article struct {
 	State         int    `json:"state"`
 }
 
+// ExistArticleByID checks if an article exists based on ID
 func ExistArticleByID(id int) (bool, error) {
 	var article Article
 	err := db.Select("id").Where("id = ? AND deleted_on = ? ", id, 0).First(&article).Error
@@ -31,6 +32,7 @@ func ExistArticleByID(id int) (bool, error) {
 	return false, nil
 }
 
+// GetArticleTotal gets the total number of articles based on the constraints
 func GetArticleTotal(maps interface{}) (int, error) {
 	var count int
 	if err := db.Model(&Article{}).Where(maps).Count(&count).Error; err != nil {
@@ -40,6 +42,7 @@ func GetArticleTotal(maps interface{}) (int, error) {
 	return count, nil
 }
 
+// GetArticles gets a list of articles based on paging constraints
 func GetArticles(pageNum int, pageSize int, maps interface{}) ([]*Article, error) {
 	var articles []*Article
 	err := db.Preload("Tag").Where(maps).Offset(pageNum).Limit(pageSize).Find(&articles).Error
@@ -50,6 +53,7 @@ func GetArticles(pageNum int, pageSize int, maps interface{}) ([]*Article, error
 	return articles, nil
 }
 
+// GetArticle Get a single article based on ID
 func GetArticle(id int) (*Article, error) {
 	var article Article
 	err := db.Where("id = ? AND deleted_on = ? ", id, 0).First(&article).Related(&article.Tag).Error
@@ -60,6 +64,7 @@ func GetArticle(id int) (*Article, error) {
 	return &article, nil
 }
 
+// EditArticle modify a single article
 func EditArticle(id int, data interface{}) error {
 	if err := db.Model(&Article{}).Where("id = ? AND deleted_on = ? ", id, 0).Updates(data).Error; err != nil {
 		return err
@@ -68,6 +73,7 @@ func EditArticle(id int, data interface{}) error {
 	return nil
 }
 
+// AddArticle add a single article
 func AddArticle(data map[string]interface{}) error {
 	article := Article{
 		TagID:         data["tag_id"].(int),
@@ -85,6 +91,7 @@ func AddArticle(data map[string]interface{}) error {
 	return nil
 }
 
+// DeleteArticle delete a single article
 func DeleteArticle(id int) error {
 	if err := db.Where("id = ?", id).Delete(Article{}).Error; err != nil {
 		return err
@@ -93,6 +100,7 @@ func DeleteArticle(id int) error {
 	return nil
 }
 
+// CleanAllArticle clear all article
 func CleanAllArticle() error {
 	if err := db.Unscoped().Where("deleted_on != ? ", 0).Delete(&Article{}).Error; err != nil {
 		return err

diff --git a/models/auth.go b/models/auth.go
@@ -8,6 +8,7 @@ type Auth struct {
 	Password string `json:"password"`
 }
 
+// CheckAuth checks if authentication information exists
 func CheckAuth(username, password string) (bool, error) {
 	var auth Auth
 	err := db.Select("id").Where(Auth{Username: username, Password: password}).First(&auth).Error

diff --git a/models/models.go b/models/models.go
@@ -20,6 +20,7 @@ type Model struct {
 	DeletedOn  int `json:"deleted_on"`
 }
 
+// Setup initializes the database instance
 func Setup() {
 	var err error
 	db, err = gorm.Open(setting.DatabaseSetting.Type, fmt.Sprintf("%s:%s@tcp(%s)/%s?charset=utf8&parseTime=True&loc=Local",
@@ -44,6 +45,7 @@ func Setup() {
 	db.DB().SetMaxOpenConns(100)
 }
 
+// CloseDB closes database connection (unnecessary)
 func CloseDB() {
 	defer db.Close()
 }
@@ -73,6 +75,7 @@ func updateTimeStampForUpdateCallback(scope *gorm.Scope) {
 	}
 }
 
+// deleteCallback will set `DeletedOn` where deleting
 func deleteCallback(scope *gorm.Scope) {
 	if !scope.HasError() {
 		var extraOption string
@@ -102,6 +105,7 @@ func deleteCallback(scope *gorm.Scope) {
 	}
 }
 
+// addExtraSpaceIfExist adds a separator
 func addExtraSpaceIfExist(str string) string {
 	if str != "" {
 		return " " + str

diff --git a/models/tag.go b/models/tag.go
@@ -13,6 +13,7 @@ type Tag struct {
 	State      int    `json:"state"`
 }
 
+// ExistTagByName checks if there is a tag with the same name
 func ExistTagByName(name string) (bool, error) {
 	var tag Tag
 	err := db.Select("id").Where("name = ? AND deleted_on = ? ", name, 0).First(&tag).Error
@@ -27,6 +28,7 @@ func ExistTagByName(name string) (bool, error) {
 	return false, nil
 }
 
+// AddTag Add a Tag
 func AddTag(name string, state int, createdBy string) error {
 	tag := Tag{
 		Name:      name,
@@ -40,6 +42,7 @@ func AddTag(name string, state int, createdBy string) error {
 	return nil
 }
 
+// GetTags gets a list of tags based on paging and constraints
 func GetTags(pageNum int, pageSize int, maps interface{}) ([]Tag, error) {
 	var (
 		tags []Tag
@@ -59,6 +62,7 @@ func GetTags(pageNum int, pageSize int, maps interface{}) ([]Tag, error) {
 	return tags, nil
 }
 
+// GetTagTotal counts the total number of tags based on the constraint
 func GetTagTotal(maps interface{}) (int, error) {
 	var count int
 	if err := db.Model(&Tag{}).Where(maps).Count(&count).Error; err != nil {
@@ -68,6 +72,7 @@ func GetTagTotal(maps interface{}) (int, error) {
 	return count, nil
 }
 
+// ExistTagByID determines whether a Tag exists based on the ID
 func ExistTagByID(id int) (bool, error) {
 	var tag Tag
 	err := db.Select("id").Where("id = ? AND deleted_on = ? ", id, 0).First(&tag).Error
@@ -81,6 +86,7 @@ func ExistTagByID(id int) (bool, error) {
 	return false, nil
 }
 
+// DeleteTag delete a tag
 func DeleteTag(id int) error {
 	if err := db.Where("id = ?", id).Delete(&Tag{}).Error; err != nil {
 		return err
@@ -89,6 +95,7 @@ func DeleteTag(id int) error {
 	return nil
 }
 
+// EditTag modify a single tag
 func EditTag(id int, data interface{}) error {
 	if err := db.Model(&Tag{}).Where("id = ? AND deleted_on = ? ", id, 0).Updates(data).Error; err != nil {
 		return err
@@ -97,6 +104,7 @@ func EditTag(id int, data interface{}) error {
 	return nil
 }
 
+// CleanAllTag clear all tag
 func CleanAllTag() (bool, error) {
 	if err := db.Unscoped().Where("deleted_on != ? ", 0).Delete(&Tag{}).Error; err != nil {
 		return false, err

diff --git a/pkg/app/form.go b/pkg/app/form.go
@@ -8,6 +8,7 @@ import (
 	"github.com/EDDYCJY/go-gin-example/pkg/e"
 )
 
+// BindAndValid binds and validates data
 func BindAndValid(c *gin.Context, form interface{}) (int, int) {
 	err := c.Bind(form)
 	if err != nil {

diff --git a/pkg/app/request.go b/pkg/app/request.go
@@ -6,6 +6,7 @@ import (
 	"github.com/EDDYCJY/go-gin-example/pkg/logging"
 )
 
+// MarkErrors logs error logs
 func MarkErrors(errors []*validation.Error) {
 	for _, err := range errors {
 		logging.Info(err.Key, err.Message)

diff --git a/pkg/app/response.go b/pkg/app/response.go
@@ -16,6 +16,7 @@ type Response struct {
 	Data interface{} `json:"data"`
 }
 
+// Response setting gin.JSON
 func (g *Gin) Response(httpCode, errCode int, data interface{}) {
 	g.C.JSON(httpCode, Response{
 		Code: httpCode,

diff --git a/pkg/e/msg.go b/pkg/e/msg.go
@@ -32,6 +32,7 @@ var MsgFlags = map[int]string{
 	ERROR_UPLOAD_CHECK_IMAGE_FORMAT: "校验图片错误，图片格式或大小有问题",
 }
 
+// GetMsg get error information based on Code
 func GetMsg(code int) string {
 	msg, ok := MsgFlags[code]
 	if ok {

diff --git a/pkg/export/excel.go b/pkg/export/excel.go
@@ -4,14 +4,17 @@ import "github.com/EDDYCJY/go-gin-example/pkg/setting"
 
 const EXT = ".xlsx"
 
+// GetExcelFullUrl get the full access path of the Excel file
 func GetExcelFullUrl(name string) string {
 	return setting.AppSetting.PrefixUrl + "/" + GetExcelPath() + name
 }
 
+// GetExcelPath get the relative save path of the Excel file
 func GetExcelPath() string {
 	return setting.AppSetting.ExportSavePath
 }
 
+// GetExcelFullPath Get the full save path of the Excel file
 func GetExcelFullPath() string {
 	return setting.AppSetting.RuntimeRootPath + GetExcelPath()
 }
diff --git a/pkg/file/file.go b/pkg/file/file.go
@@ -8,28 +8,33 @@ import (
 	"path"
 )
 
+// GetSize get the file size
 func GetSize(f multipart.File) (int, error) {
 	content, err := ioutil.ReadAll(f)
 
 	return len(content), err
 }
 
+// GetExt get the file ext
 func GetExt(fileName string) string {
 	return path.Ext(fileName)
 }
 
+// CheckNotExist check if the file exists
 func CheckNotExist(src string) bool {
 	_, err := os.Stat(src)
 
 	return os.IsNotExist(err)
 }
 
+// CheckPermission check if the file has permission
 func CheckPermission(src string) bool {
 	_, err := os.Stat(src)
 
 	return os.IsPermission(err)
 }
 
+// IsNotExistMkDir create a directory if it does not exist
 func IsNotExistMkDir(src string) error {
 	if notExist := CheckNotExist(src); notExist == true {
 		if err := MkDir(src); err != nil {
@@ -40,6 +45,7 @@ func IsNotExistMkDir(src string) error {
 	return nil
 }
 
+// MkDir create a directory
 func MkDir(src string) error {
 	err := os.MkdirAll(src, os.ModePerm)
 	if err != nil {
@@ -49,6 +55,7 @@ func MkDir(src string) error {
 	return nil
 }
 
+// Open a file according to a specific mode
 func Open(name string, flag int, perm os.FileMode) (*os.File, error) {
 	f, err := os.OpenFile(name, flag, perm)
 	if err != nil {
@@ -58,6 +65,7 @@ func Open(name string, flag int, perm os.FileMode) (*os.File, error) {
 	return f, nil
 }
 
+// MustOpen maximize trying to open the file
 func MustOpen(fileName, filePath string) (*os.File, error) {
 	dir, err := os.Getwd()
 	if err != nil {

diff --git a/pkg/gredis/redis.go b/pkg/gredis/redis.go
@@ -11,6 +11,7 @@ import (
 
 var RedisConn *redis.Pool
 
+// Setup Initialize the Redis instance
 func Setup() error {
 	RedisConn = &redis.Pool{
 		MaxIdle:     setting.RedisSetting.MaxIdle,
@@ -38,6 +39,7 @@ func Setup() error {
 	return nil
 }
 
+// Set a key/value
 func Set(key string, data interface{}, time int) error {
 	conn := RedisConn.Get()
 	defer conn.Close()
@@ -60,6 +62,7 @@ func Set(key string, data interface{}, time int) error {
 	return nil
 }
 
+// Exists check a key
 func Exists(key string) bool {
 	conn := RedisConn.Get()
 	defer conn.Close()
@@ -72,6 +75,7 @@ func Exists(key string) bool {
 	return exists
 }
 
+// Get get a key
 func Get(key string) ([]byte, error) {
 	conn := RedisConn.Get()
 	defer conn.Close()
@@ -84,13 +88,15 @@ func Get(key string) ([]byte, error) {
 	return reply, nil
 }
 
+// Delete delete a kye
 func Delete(key string) (bool, error) {
 	conn := RedisConn.Get()
 	defer conn.Close()
 
 	return redis.Bool(conn.Do("DEL", key))
 }
 
+// LikeDeletes batch delete
 func LikeDeletes(key string) error {
 	conn := RedisConn.Get()
 	defer conn.Close()

diff --git a/pkg/logging/file.go b/pkg/logging/file.go
@@ -7,39 +7,16 @@ import (
 	"github.com/EDDYCJY/go-gin-example/pkg/setting"
 )
 
+// getLogFilePath get the log file save path
 func getLogFilePath() string {
 	return fmt.Sprintf("%s%s", setting.AppSetting.RuntimeRootPath, setting.AppSetting.LogSavePath)
 }
 
+// getLogFileName get the save name of the log file
 func getLogFileName() string {
 	return fmt.Sprintf("%s%s.%s",
 		setting.AppSetting.LogSaveName,
 		time.Now().Format(setting.AppSetting.TimeFormat),
 		setting.AppSetting.LogFileExt,
 	)
-}
-
-//func openLogFile(fileName, filePath string) (*os.File, error) {
-//	dir, err := os.Getwd()
-//	if err != nil {
-//		return nil, fmt.Errorf("os.Getwd err: %v", err)
-//	}
-//
-//	src := dir + "/" + filePath
-//	perm := file.CheckPermission(src)
-//	if perm == true {
-//		return nil, fmt.Errorf("file.CheckPermission Permission denied src: %s", src)
-//	}
-//
-//	err = file.IsNotExistMkDir(src)
-//	if err != nil {
-//		return nil, fmt.Errorf("file.IsNotExistMkDir src: %s, err: %v", src, err)
-//	}
-//
-//	f, err := file.Open(src+fileName, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
-//	if err != nil {
-//		return nil, fmt.Errorf("Fail to OpenFile :%v", err)
-//	}
-//
-//	return f, nil
-//}
+}