增加多行记录返回map结构的功能，优化生成的文档注释

Author: alex cai

README.md

@@ -26,6 +26,7 @@ go-db-models
   - 单行结果查询函数
   - 根据某个字段查询单行记录的函数，例如根据id字段进行查询
   - 多行结果查询函数
+  - 返回多行结果时，可以选择生成list（默认）或map格式
 
 `*_tb_gen.go`文件样例如下：
 
@@ -129,6 +130,9 @@ func AdProjectQuery(db *sql.DB, queryString string) (ad_project []*AdProjectTabl
             "fields": ["id", "name", "status", "daily_budget", "start_date", "created_at"],
             // [可选]这是可选项，如果定义了该字段，则会自动生成一个类似QueryById的查询函数。
             "queryBy": "id",
+            // [可选]返回多行数据时，默认返回格式是list，但是可以通过指定该字段，来返回map结构，其下标就是对应的字段的值。
+            // 该字段通常是主键或者唯一索引的字段，否则就可能出现重复值
+            "mapIndex": "id",
             // [可选]结构体增加注释
             "msg": "这是注释。。。"
         },

models/db.go

@@ -22,7 +22,15 @@ type Table struct {
 	Fields []Field
 }
 
-// 字段定义
+/*
+字段定义
+使用MySQL数据库desc 表名时，我们看到Key那一栏，可能会有4种值，即 ' '，'PRI'，'UNI'，'MUL'。
+
+- 如果Key是空的，那么该列值的可以重复，表示该列没有索引，或者是一个非唯一的复合索引的非前导列；
+- 如果Key是PRI，那么该列是主键的组成部分；
+- 如果Key是UNI，那么该列是一个唯一值索引的第一列（前导列），并别不能含有空值（NULL）；
+- 如果Key是MUL，那么该列的值可以重复，该列是一个非唯一索引的前导列（第一列）或者是一个唯一性索引的组成部分但是可以含有空值NULL。
+*/
 type Field struct {
 	Name    string
 	Type    string

models/json.go

@@ -12,10 +12,11 @@ type JsonConf struct {
 
 // 单个数据表的配置
 type JsonTableConf struct {
-	Name    string   // 表名
-	Fields  []string // 字段名
-	QueryBy string   // QueryBy函数定义
-	Msg     string   // 表结构说明
+	Name     string   // 表名
+	Fields   []string // 字段名
+	QueryBy  string   // QueryBy函数定义
+	MapIndex string   // 返回map结构时的下标字段名
+	Msg      string   // 表结构说明
 }
 
 // 将json文件decode成结构体

models/parse_table.go

@@ -15,12 +15,16 @@ const (
 type ParseTable struct {
 	Name         string   // 数据表名，如：ad_plan，对应结构体名为：AdPlanTable，对应文件名为：gen_ad_plan.go
 	PackageName  string   // 生成的程序的包名
-	PrimaryType  string   // 主键的类型，如：uint32, sql.NullString等
+	PrimaryType  string   // 主键的类型，如：uint32, string等
 	Imports      []string // 需要import的包
 	SelectFields string   // sql查询中的select fields
 	Msg          string   // 表结构的说明
 	Fields       []ParseField
 	QueryBy      QueryBy // QueryBy函数，例如QueryById等
+
+	// 如果该字段不为空，则返回多行记录时，是map结构（默认是list结构）
+	// 关联json中的MapIndex字段
+	MapIndex MapIndexField
 }
 
 // 字段的定义
@@ -29,6 +33,11 @@ type ParseField struct {
 	Type string // 字段类型，对应golang中的类型，如：uint32, sql.NullString
 }
 
+type MapIndexField struct {
+	Name string // map下标的字段名
+	Type string // map下标字段的类型
+}
+
 // 生成QueryBy函数时需要该结构
 type QueryBy struct {
 	FieldName string // query by函数的参数名
@@ -47,6 +56,7 @@ func ParseTablesStruct(tables []Table, packageName string, modelsConf *JsonConf)
 	var modelsConfMap = map[string]map[string]bool{} // 第一个下标是表名，第二个下标是字段名
 	var queryByConf = map[string]string{}            // 下标是表名，值是字段名，例如id。
 	var tableConfMsg = map[string]string{}           // 表的注释（在json文件中的）
+	var mapIndexConf = map[string]string{}           // map下标配置
 	if len(modelsConf.Tables) > 0 {
 		for _, tb := range modelsConf.Tables {
 			modelsConfMap[tb.Name] = map[string]bool{}
@@ -58,6 +68,10 @@ func ParseTablesStruct(tables []Table, packageName string, modelsConf *JsonConf)
 				queryByConf[tb.Name] = tb.QueryBy
 			}
 
+			if tb.MapIndex != "" {
+				mapIndexConf[tb.Name] = tb.MapIndex
+			}
+
 			tableConfMsg[tb.Name] = tb.Msg
 		}
 	}
@@ -98,6 +112,23 @@ func ParseTablesStruct(tables []Table, packageName string, modelsConf *JsonConf)
 			}
 		}
 
+		// 处理map index
+		if mapIndexConf[table.Name] != "" {
+			isMatch := false
+			for _, f := range ptable.Fields {
+				if f.Name == mapIndexConf[table.Name] {
+					isMatch = true
+					ptable.MapIndex.Name = f.Name
+					ptable.MapIndex.Type = f.Type
+				}
+			}
+
+			if isMatch == false {
+				// query by的字段不在字段列表里
+				return nil, errors.New("ERROR field name: " + mapIndexConf[table.Name] + " of MapIndex for table name: " + table.Name)
+			}
+		}
+
 		// 生成代码文件
 		err = GenFile(ptable)
 		if err != nil {

models/template.go

@@ -3,7 +3,7 @@ package models
 const (
 	// 生成的数据表的文件的模版: gen_table_*.go
 	codeTemplate = `// DON'T EDIT *** generated by go-db-models *** DON'T EDIT //
-// 数据表：{{.Name}}
+
 package {{.PackageName}}
 
 {{range $k, $v := .Imports}}
@@ -65,7 +65,7 @@ func do{{.Name|Format2StructName}}QueryRow(db *sql.DB, queryString string) ({{.N
 
 // 根据where条件查询多行记录
 // 如果查询所有记录，只需要where="1"
-func {{.Name|Format2StructName}}QueryWhere(db *sql.DB, where string) ({{.Name}} []*{{.Name|Format2StructName}}Table, err error) {
+func {{.Name|Format2StructName}}QueryWhere(db *sql.DB, where string) ({{.Name}} {{if .MapIndex.Name}}map[{{.MapIndex.Type}}]*{{.Name|Format2StructName}}Table{{else}}[]*{{.Name|Format2StructName}}Table{{end}}, err error) {
 	queryString := "SELECT " + {{.Name|Format2Title}}SelectFields + " FROM {{.Name|AddBackquote}} WHERE " + where
 	return do{{.Name|Format2StructName}}Query(db, queryString)
 }
@@ -74,13 +74,13 @@ func {{.Name|Format2StructName}}QueryWhere(db *sql.DB, where string) ({{.Name}}
 // 外部使用时，SQL语句应该这样写：
 //   select {select-fields-temp} from ad_plan where status = 1
 // 其中{select-fields-temp}会自动替换为相应的字段名
-func {{.Name|Format2StructName}}Query(db *sql.DB, queryString string) ({{.Name}} []*{{.Name|Format2StructName}}Table, err error) {
+func {{.Name|Format2StructName}}Query(db *sql.DB, queryString string) ({{.Name}} {{if .MapIndex.Name}}map[{{.MapIndex.Type}}]*{{.Name|Format2StructName}}Table{{else}}[]*{{.Name|Format2StructName}}Table{{end}}, err error) {
 	queryString = strings.Replace(queryString, SelectFieldsTemp, {{.Name|Format2Title}}SelectFields, 1)
 	return do{{.Name|Format2StructName}}Query(db, queryString)
 }
 
 // 查询多行记录（内部调用）
-func do{{.Name|Format2StructName}}Query(db *sql.DB, queryString string) ({{.Name}} []*{{.Name|Format2StructName}}Table, err error) {
+func do{{.Name|Format2StructName}}Query(db *sql.DB, queryString string) ({{.Name}} {{if .MapIndex.Name}}map[{{.MapIndex.Type}}]*{{.Name|Format2StructName}}Table{{else}}[]*{{.Name|Format2StructName}}Table{{end}}, err error) {
 	rows, err := db.Query(queryString)
 	if err != nil {
 		return nil, err
@@ -96,14 +96,19 @@ func do{{.Name|Format2StructName}}Query(db *sql.DB, queryString string) ({{.Name
 			return nil, err
 		}
 
+		{{if .MapIndex.Name}}
+		{{.Name}}[oneRow.{{.MapIndex.Name|Format2StructName}}] = oneRow
+		{{else}}
 		{{.Name}} = append({{.Name}}, oneRow)
+		{{end}}
 	}
 
 	return {{.Name}}, nil
 }
 `
 	// 生成的gen_common.go文件的模版
 	commonCodeTemplate = `// DON'T EDIT *** generated by go-db-models *** DON'T EDIT //
+	
 package {{.PackageName}}
 
 const (