mono code generation

Overview

The mono code is generated by goctl generating model files with the specified document name. The mono does not have form statements like mysql, indexes, and so forth, so mono code generation does not need information like sql or database links.

Task Targets

  1. familiar with goctl generating mono code usage and learn about currently supported instructions and features
  2. Preliminary understanding of the format of goctl generating mono code

Preparing

  1. Complete golang installation
  2. Complete goctl installation

Code Generation

  1. # Create workspaces and projects
  2. $ mkdir -p ~/workspace/model/mongo && ~/workspace/model/mongo
  3. # Generate mongo code with document name User
  4. $ goctl model mongo --type user --dir .
  5. # View generated files
  6. $ ls
  7. error.go        usermodel.go    usermodelgen.go usertypes.go
  8. # view directory tree
  9. .
  10. ├── error.go
  11. ├── usermodel.go
  12. ├── usermodelgen.go
  13. └── usertypes.go
  15. 0 directories, 4 files

View code

  • error.go
  • usermodel.go
  • usermodelgen.go
  • usertypes.go
  1. package model
  3. import (
  4.     "errors"
  6.     "github.com/zeromicro/go-zero/core/stores/mon"
  7. )
  9. var (
  10.     ErrNotFound        = mon.ErrNotFound
  11.     ErrInvalidObjectId = errors.New("invalid objectId")
  12. )
  1. package model
  3. import "github.com/zeromicro/go-zero/core/stores/mon"
  5. var _ UserModel = (*customUserModel)(nil)
  7. type (
  8.     // UserModel is an interface to be customized, add more methods here,
  9.     // and implement the added methods in customUserModel.
  10.     UserModel interface {
  11.         userModel
  12.     }
  14.     customUserModel struct {
  15.         *defaultUserModel
  16.     }
  17. )
  19. // NewUserModel returns a model for the mongo.
  20. func NewUserModel(url, db, collection string) UserModel {
  21.     conn := mon.MustNewModel(url, db, collection)
  22.     return &customUserModel{
  23.         defaultUserModel: newDefaultUserModel(conn),
  24.     }
  25. }
  1. // Code generated by goctl. DO NOT EDIT.
  2. package model
  4. import (
  5.     "context"
  6.     "time"
  8.     "github.com/zeromicro/go-zero/core/stores/mon"
  9.     "go.mongodb.org/mongo-driver/bson"
  10.     "go.mongodb.org/mongo-driver/bson/primitive"
  11. )
  13. type userModel interface {
  14.     Insert(ctx context.Context, data *User) error
  15.     FindOne(ctx context.Context, id string) (*User, error)
  16.     Update(ctx context.Context, data *User) error
  17.     Delete(ctx context.Context, id string) error
  18. }
  20. type defaultUserModel struct {
  21.     conn *mon.Model
  22. }
  24. func newDefaultUserModel(conn *mon.Model) *defaultUserModel {
  25.     return &defaultUserModel{conn: conn}
  26. }
  28. func (m *defaultUserModel) Insert(ctx context.Context, data *User) error {
  29.     if data.ID.IsZero() {
  30.         data.ID = primitive.NewObjectID()
  31.         data.CreateAt = time.Now()
  32.         data.UpdateAt = time.Now()
  33.     }
  35.     _, err := m.conn.InsertOne(ctx, data)
  36.     return err
  37. }
  39. func (m *defaultUserModel) FindOne(ctx context.Context, id string) (*User, error) {
  40.     oid, err := primitive.ObjectIDFromHex(id)
  41.     if err != nil {
  42.         return nil, ErrInvalidObjectId
  43.     }
  45.     var data User
  47.     err = m.conn.FindOne(ctx, &data, bson.M{"_id": oid})
  48.     switch err {
  49.     case nil:
  50.         return &data, nil
  51.     case mon.ErrNotFound:
  52.         return nil, ErrNotFound
  53.     default:
  54.         return nil, err
  55.     }
  56. }
  58. func (m *defaultUserModel) Update(ctx context.Context, data *User) error {
  59.     data.UpdateAt = time.Now()
  61.     _, err := m.conn.ReplaceOne(ctx, bson.M{"_id": data.ID}, data)
  62.     return err
  63. }
  65. func (m *defaultUserModel) Delete(ctx context.Context, id string) error {
  66.     oid, err := primitive.ObjectIDFromHex(id)
  67.     if err != nil {
  68.         return ErrInvalidObjectId
  69.     }
  71.     _, err = m.conn.DeleteOne(ctx, bson.M{"_id": oid})
  72.     return err
  73. }
  1. package model
  3. import (
  4.     "time"
  6.     "go.mongodb.org/mongo-driver/bson/primitive"
  7. )
  9. type User struct {
  10.     ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  11.     // TODO: Fill your own fields
  12.     UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  13.     CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  14. }

References