Code optimized (#523)

* optimized markdown generator

* optimized markdown generator

* optimized markdown generator

* add more comment

* add comment

* add comment

* add comments for rpc tool

* add comments for model tool

* add comments for model tool

* add comments for model tool

* add comments for config tool

* add comments for config tool

* add comments

* add comments

* add comments

* add comments

* add comment

* remove rpc main head info

* add comment

* optimized

Co-authored-by: anqiansong <anqiansong@xiaoheiban.cn>

tools/goctl/model/sql/test/model/model_test.go

@@ -20,11 +20,11 @@ func TestStudentModel(t *testing.T) {
 		testTable              = "`student`"
 		testUpdateName         = "gozero1"
 		testRowsAffected int64 = 1
-		testInsertId     int64 = 1
+		testInsertID     int64 = 1
 	)
 
 	var data Student
-	data.Id = testInsertId
+	data.ID = testInsertID
 	data.Name = "gozero"
 	data.Age = sql.NullInt64{
 		Int64: 1,
@@ -43,14 +43,14 @@ func TestStudentModel(t *testing.T) {
 	err := mockStudent(func(mock sqlmock.Sqlmock) {
 		mock.ExpectExec(fmt.Sprintf("insert into %s", testTable)).
 			WithArgs(data.Name, data.Age, data.Score).
-			WillReturnResult(sqlmock.NewResult(testInsertId, testRowsAffected))
+			WillReturnResult(sqlmock.NewResult(testInsertID, testRowsAffected))
 	}, func(m StudentModel) {
 		r, err := m.Insert(data)
 		assert.Nil(t, err)
 
-		lastInsertId, err := r.LastInsertId()
+		lastInsertID, err := r.LastInsertId()
 		assert.Nil(t, err)
-		assert.Equal(t, testInsertId, lastInsertId)
+		assert.Equal(t, testInsertID, lastInsertID)
 
 		rowsAffected, err := r.RowsAffected()
 		assert.Nil(t, err)
@@ -60,17 +60,17 @@ func TestStudentModel(t *testing.T) {
 
 	err = mockStudent(func(mock sqlmock.Sqlmock) {
 		mock.ExpectQuery(fmt.Sprintf("select (.+) from %s", testTable)).
-			WithArgs(testInsertId).
-			WillReturnRows(sqlmock.NewRows([]string{"id", "name", "age", "score", "create_time", "update_time"}).AddRow(testInsertId, data.Name, data.Age, data.Score, testTimeValue, testTimeValue))
+			WithArgs(testInsertID).
+			WillReturnRows(sqlmock.NewRows([]string{"id", "name", "age", "score", "create_time", "update_time"}).AddRow(testInsertID, data.Name, data.Age, data.Score, testTimeValue, testTimeValue))
 	}, func(m StudentModel) {
-		result, err := m.FindOne(testInsertId)
+		result, err := m.FindOne(testInsertID)
 		assert.Nil(t, err)
 		assert.Equal(t, *result, data)
 	})
 	assert.Nil(t, err)
 
 	err = mockStudent(func(mock sqlmock.Sqlmock) {
-		mock.ExpectExec(fmt.Sprintf("update %s", testTable)).WithArgs(testUpdateName, data.Age, data.Score, testInsertId).WillReturnResult(sqlmock.NewResult(testInsertId, testRowsAffected))
+		mock.ExpectExec(fmt.Sprintf("update %s", testTable)).WithArgs(testUpdateName, data.Age, data.Score, testInsertID).WillReturnResult(sqlmock.NewResult(testInsertID, testRowsAffected))
 	}, func(m StudentModel) {
 		data.Name = testUpdateName
 		err := m.Update(data)
@@ -80,19 +80,19 @@ func TestStudentModel(t *testing.T) {
 
 	err = mockStudent(func(mock sqlmock.Sqlmock) {
 		mock.ExpectQuery(fmt.Sprintf("select (.+) from %s ", testTable)).
-			WithArgs(testInsertId).
-			WillReturnRows(sqlmock.NewRows([]string{"id", "name", "age", "score", "create_time", "update_time"}).AddRow(testInsertId, data.Name, data.Age, data.Score, testTimeValue, testTimeValue))
+			WithArgs(testInsertID).
+			WillReturnRows(sqlmock.NewRows([]string{"id", "name", "age", "score", "create_time", "update_time"}).AddRow(testInsertID, data.Name, data.Age, data.Score, testTimeValue, testTimeValue))
 	}, func(m StudentModel) {
-		result, err := m.FindOne(testInsertId)
+		result, err := m.FindOne(testInsertID)
 		assert.Nil(t, err)
 		assert.Equal(t, *result, data)
 	})
 	assert.Nil(t, err)
 
 	err = mockStudent(func(mock sqlmock.Sqlmock) {
-		mock.ExpectExec(fmt.Sprintf("delete from %s where `id` = ?", testTable)).WithArgs(testInsertId).WillReturnResult(sqlmock.NewResult(testInsertId, testRowsAffected))
+		mock.ExpectExec(fmt.Sprintf("delete from %s where `id` = ?", testTable)).WithArgs(testInsertID).WillReturnResult(sqlmock.NewResult(testInsertID, testRowsAffected))
 	}, func(m StudentModel) {
-		err := m.Delete(testInsertId)
+		err := m.Delete(testInsertID)
 		assert.Nil(t, err)
 	})
 	assert.Nil(t, err)
@@ -109,11 +109,11 @@ func TestUserModel(t *testing.T) {
 		testGender             = "男"
 		testNickname           = "test_nickname"
 		testRowsAffected int64 = 1
-		testInsertId     int64 = 1
+		testInsertID     int64 = 1
 	)
 
 	var data User
-	data.Id = testInsertId
+	data.ID = testInsertID
 	data.User = testUser
 	data.Name = "gozero"
 	data.Password = testPassword
@@ -126,14 +126,14 @@ func TestUserModel(t *testing.T) {
 	err := mockUser(func(mock sqlmock.Sqlmock) {
 		mock.ExpectExec(fmt.Sprintf("insert into %s", testTable)).
 			WithArgs(data.User, data.Name, data.Password, data.Mobile, data.Gender, data.Nickname).
-			WillReturnResult(sqlmock.NewResult(testInsertId, testRowsAffected))
+			WillReturnResult(sqlmock.NewResult(testInsertID, testRowsAffected))
 	}, func(m UserModel) {
 		r, err := m.Insert(data)
 		assert.Nil(t, err)
 
-		lastInsertId, err := r.LastInsertId()
+		lastInsertID, err := r.LastInsertId()
 		assert.Nil(t, err)
-		assert.Equal(t, testInsertId, lastInsertId)
+		assert.Equal(t, testInsertID, lastInsertID)
 
 		rowsAffected, err := r.RowsAffected()
 		assert.Nil(t, err)
@@ -143,17 +143,17 @@ func TestUserModel(t *testing.T) {
 
 	err = mockUser(func(mock sqlmock.Sqlmock) {
 		mock.ExpectQuery(fmt.Sprintf("select (.+) from %s", testTable)).
-			WithArgs(testInsertId).
-			WillReturnRows(sqlmock.NewRows([]string{"id", "user", "name", "password", "mobile", "gender", "nickname", "create_time", "update_time"}).AddRow(testInsertId, data.User, data.Name, data.Password, data.Mobile, data.Gender, data.Nickname, testTimeValue, testTimeValue))
+			WithArgs(testInsertID).
+			WillReturnRows(sqlmock.NewRows([]string{"id", "user", "name", "password", "mobile", "gender", "nickname", "create_time", "update_time"}).AddRow(testInsertID, data.User, data.Name, data.Password, data.Mobile, data.Gender, data.Nickname, testTimeValue, testTimeValue))
 	}, func(m UserModel) {
-		result, err := m.FindOne(testInsertId)
+		result, err := m.FindOne(testInsertID)
 		assert.Nil(t, err)
 		assert.Equal(t, *result, data)
 	})
 	assert.Nil(t, err)
 
 	err = mockUser(func(mock sqlmock.Sqlmock) {
-		mock.ExpectExec(fmt.Sprintf("update %s", testTable)).WithArgs(data.User, testUpdateName, data.Password, data.Mobile, data.Gender, data.Nickname, testInsertId).WillReturnResult(sqlmock.NewResult(testInsertId, testRowsAffected))
+		mock.ExpectExec(fmt.Sprintf("update %s", testTable)).WithArgs(data.User, testUpdateName, data.Password, data.Mobile, data.Gender, data.Nickname, testInsertID).WillReturnResult(sqlmock.NewResult(testInsertID, testRowsAffected))
 	}, func(m UserModel) {
 		data.Name = testUpdateName
 		err := m.Update(data)
@@ -163,19 +163,19 @@ func TestUserModel(t *testing.T) {
 
 	err = mockUser(func(mock sqlmock.Sqlmock) {
 		mock.ExpectQuery(fmt.Sprintf("select (.+) from %s ", testTable)).
-			WithArgs(testInsertId).
-			WillReturnRows(sqlmock.NewRows([]string{"id", "user", "name", "password", "mobile", "gender", "nickname", "create_time", "update_time"}).AddRow(testInsertId, data.User, data.Name, data.Password, data.Mobile, data.Gender, data.Nickname, testTimeValue, testTimeValue))
+			WithArgs(testInsertID).
+			WillReturnRows(sqlmock.NewRows([]string{"id", "user", "name", "password", "mobile", "gender", "nickname", "create_time", "update_time"}).AddRow(testInsertID, data.User, data.Name, data.Password, data.Mobile, data.Gender, data.Nickname, testTimeValue, testTimeValue))
 	}, func(m UserModel) {
-		result, err := m.FindOne(testInsertId)
+		result, err := m.FindOne(testInsertID)
 		assert.Nil(t, err)
 		assert.Equal(t, *result, data)
 	})
 	assert.Nil(t, err)
 
 	err = mockUser(func(mock sqlmock.Sqlmock) {
-		mock.ExpectExec(fmt.Sprintf("delete from %s where `id` = ?", testTable)).WithArgs(testInsertId).WillReturnResult(sqlmock.NewResult(testInsertId, testRowsAffected))
+		mock.ExpectExec(fmt.Sprintf("delete from %s where `id` = ?", testTable)).WithArgs(testInsertID).WillReturnResult(sqlmock.NewResult(testInsertID, testRowsAffected))
 	}, func(m UserModel) {
-		err := m.Delete(testInsertId)
+		err := m.Delete(testInsertID)
 		assert.Nil(t, err)
 	})
 	assert.Nil(t, err)

tools/goctl/model/sql/test/model/studentmodel.go

@@ -19,10 +19,11 @@ var (
 	studentRowsExpectAutoSet   = strings.Join(stringx.Remove(studentFieldNames, "`id`", "`create_time`", "`update_time`"), ",")
 	studentRowsWithPlaceHolder = strings.Join(stringx.Remove(studentFieldNames, "`id`", "`create_time`", "`update_time`"), "=?,") + "=?"
 
-	cacheStudentIdPrefix = "cache#Student#id#"
+	cacheStudentIDPrefix = "cache#Student#id#"
 )
 
 type (
+	// StudentModel defines a model for Student
 	StudentModel interface {
 		Insert(data Student) (sql.Result, error)
 		FindOne(id int64) (*Student, error)
@@ -35,8 +36,9 @@ type (
 		table string
 	}
 
+	// Student defines an data structure for mysql
 	Student struct {
-		Id         int64           `db:"id"`
+		ID         int64           `db:"id"`
 		Name       string          `db:"name"`
 		Age        sql.NullInt64   `db:"age"`
 		Score      sql.NullFloat64 `db:"score"`
@@ -45,6 +47,7 @@ type (
 	}
 )
 
+// NewStudentModel creates an instance for StudentModel
 func NewStudentModel(conn sqlx.SqlConn, c cache.CacheConf) StudentModel {
 	return &defaultStudentModel{
 		CachedConn: sqlc.NewConn(conn, c),
@@ -60,9 +63,9 @@ func (m *defaultStudentModel) Insert(data Student) (sql.Result, error) {
 }
 
 func (m *defaultStudentModel) FindOne(id int64) (*Student, error) {
-	studentIdKey := fmt.Sprintf("%s%v", cacheStudentIdPrefix, id)
+	studentIDKey := fmt.Sprintf("%s%v", cacheStudentIDPrefix, id)
 	var resp Student
-	err := m.QueryRow(&resp, studentIdKey, func(conn sqlx.SqlConn, v interface{}) error {
+	err := m.QueryRow(&resp, studentIDKey, func(conn sqlx.SqlConn, v interface{}) error {
 		query := fmt.Sprintf("select %s from %s where `id` = ? limit 1", studentRows, m.table)
 		return conn.QueryRow(v, query, id)
 	})
@@ -77,26 +80,26 @@ func (m *defaultStudentModel) FindOne(id int64) (*Student, error) {
 }
 
 func (m *defaultStudentModel) Update(data Student) error {
-	studentIdKey := fmt.Sprintf("%s%v", cacheStudentIdPrefix, data.Id)
+	studentIDKey := fmt.Sprintf("%s%v", cacheStudentIDPrefix, data.ID)
 	_, err := m.Exec(func(conn sqlx.SqlConn) (result sql.Result, err error) {
 		query := fmt.Sprintf("update %s set %s where `id` = ?", m.table, studentRowsWithPlaceHolder)
-		return conn.Exec(query, data.Name, data.Age, data.Score, data.Id)
-	}, studentIdKey)
+		return conn.Exec(query, data.Name, data.Age, data.Score, data.ID)
+	}, studentIDKey)
 	return err
 }
 
 func (m *defaultStudentModel) Delete(id int64) error {
 
-	studentIdKey := fmt.Sprintf("%s%v", cacheStudentIdPrefix, id)
+	studentIDKey := fmt.Sprintf("%s%v", cacheStudentIDPrefix, id)
 	_, err := m.Exec(func(conn sqlx.SqlConn) (result sql.Result, err error) {
 		query := fmt.Sprintf("delete from %s where `id` = ?", m.table)
 		return conn.Exec(query, id)
-	}, studentIdKey)
+	}, studentIDKey)
 	return err
 }
 
 func (m *defaultStudentModel) formatPrimary(primary interface{}) string {
-	return fmt.Sprintf("%s%v", cacheStudentIdPrefix, primary)
+	return fmt.Sprintf("%s%v", cacheStudentIDPrefix, primary)
 }
 
 func (m *defaultStudentModel) queryPrimary(conn sqlx.SqlConn, v, primary interface{}) error {

tools/goctl/model/sql/test/model/usermodel.go

@@ -20,6 +20,7 @@ var (
 )
 
 type (
+	// UserModel defines a model for user
 	UserModel interface {
 		Insert(data User) (sql.Result, error)
 		FindOne(id int64) (*User, error)
@@ -35,8 +36,9 @@ type (
 		table string
 	}
 
+	// User defines an data structure for mysql
 	User struct {
-		Id         int64     `db:"id"`
+		ID         int64     `db:"id"`
 		User       string    `db:"user"`     // 用户
 		Name       string    `db:"name"`     // 用户名称
 		Password   string    `db:"password"` // 用户密码
@@ -48,6 +50,7 @@ type (
 	}
 )
 
+// NewUserModel creates an instance for UserModel
 func NewUserModel(conn sqlx.SqlConn) UserModel {
 	return &defaultUserModel{
 		conn:  conn,
@@ -119,7 +122,7 @@ func (m *defaultUserModel) FindOneByMobile(mobile string) (*User, error) {
 
 func (m *defaultUserModel) Update(data User) error {
 	query := fmt.Sprintf("update %s set %s where `id` = ?", m.table, userRowsWithPlaceHolder)
-	_, err := m.conn.Exec(query, data.User, data.Name, data.Password, data.Mobile, data.Gender, data.Nickname, data.Id)
+	_, err := m.conn.Exec(query, data.User, data.Name, data.Password, data.Mobile, data.Gender, data.Nickname, data.ID)
 	return err
 }
 

tools/goctl/model/sql/test/model/vars.go

@@ -2,4 +2,5 @@ package model
 
 import "github.com/tal-tech/go-zero/core/stores/sqlx"
 
+// ErrNotFound types an alias for sqlx.ErrNotFound
 var ErrNotFound = sqlx.ErrNotFound

tools/goctl/model/sql/test/orm.go

@@ -13,9 +13,13 @@ import (
 const tagName = "db"
 
 var (
-	ErrNotMatchDestination  = errors.New("not matching destination to scan")
-	ErrNotReadableValue     = errors.New("value not addressable or interfaceable")
-	ErrNotSettable          = errors.New("passed in variable is not settable")
+	// ErrNotMatchDestination defines an error for mismatching case
+	ErrNotMatchDestination = errors.New("not matching destination to scan")
+	// ErrNotReadableValue defines an error for the value is not addressable or interfaceable
+	ErrNotReadableValue = errors.New("value not addressable or interfaceable")
+	// ErrNotSettable defines an error for the variable is not settable
+	ErrNotSettable = errors.New("passed in variable is not settable")
+	// ErrUnsupportedValueType deinfes an error for unsupported unmarshal type
 	ErrUnsupportedValueType = errors.New("unsupported unmarshal type")
 )
 

tools/goctl/model/sql/test/sqlconn.go

@@ -9,6 +9,7 @@ import (
 )
 
 type (
+	// MockConn defines a mock connection instance for mysql
 	MockConn struct {
 		db *sql.DB
 	}
@@ -17,43 +18,51 @@ type (
 	}
 )
 
+// NewMockConn creates an instance for MockConn
 func NewMockConn(db *sql.DB) *MockConn {
 	return &MockConn{db: db}
 }
 
+// Exec executes sql and returns the result
 func (conn *MockConn) Exec(query string, args ...interface{}) (sql.Result, error) {
 	return exec(conn.db, query, args...)
 }
 
+// Prepare executes sql by sql.DB
 func (conn *MockConn) Prepare(query string) (sqlx.StmtSession, error) {
 	st, err := conn.db.Prepare(query)
 	return statement{stmt: st}, err
 }
 
+// QueryRow executes sql and returns a query row
 func (conn *MockConn) QueryRow(v interface{}, q string, args ...interface{}) error {
 	return query(conn.db, func(rows *sql.Rows) error {
 		return unmarshalRow(v, rows, true)
 	}, q, args...)
 }
 
+// QueryRowPartial executes sql and returns a partial query row
 func (conn *MockConn) QueryRowPartial(v interface{}, q string, args ...interface{}) error {
 	return query(conn.db, func(rows *sql.Rows) error {
 		return unmarshalRow(v, rows, false)
 	}, q, args...)
 }
 
+// QueryRows executes sql and returns  query rows
 func (conn *MockConn) QueryRows(v interface{}, q string, args ...interface{}) error {
 	return query(conn.db, func(rows *sql.Rows) error {
 		return unmarshalRows(v, rows, true)
 	}, q, args...)
 }
 
+// QueryRowsPartial executes sql and returns partial query rows
 func (conn *MockConn) QueryRowsPartial(v interface{}, q string, args ...interface{}) error {
 	return query(conn.db, func(rows *sql.Rows) error {
 		return unmarshalRows(v, rows, false)
 	}, q, args...)
 }
 
+// Transact is the implemention of sqlx.SqlConn, nothing to do
 func (conn *MockConn) Transact(func(session sqlx.Session) error) error {
 	return nil
 }

tools/goctl/model/sql/test/utils.go

@@ -94,11 +94,6 @@ func format(query string, args ...interface{}) (string, error) {
 	return b.String(), nil
 }
 
-func logInstanceError(datasource string, err error) {
-	datasource = desensitize(datasource)
-	logx.Errorf("Error on getting sql instance of %s: %v", datasource, err)
-}
-
 func logSqlError(stmt string, err error) {
 	if err != nil && err != ErrNotFound {
 		logx.Errorf("stmt: %s, error: %s", stmt, err.Error())