Bootstrap

Mainly used to add some logic after the framework initialization to bootstrap the business system startup and to perform some cleanup logic after the system stops, for example the gorm database connection in the framework is connected and disconnected through bootstrap

Detailed examples referencehere

How to implement

Implement the following methods

// Initiator methods that need to be implemented
type Initiator interface {
	// Start
	Start() error
	// Stop
	Stop()
}

Bootstrap

Executed after framework initialization and before service start

Add to bootstrap queue

import "github.com/asjard/asjard/core/bootstrap"

type CustomeBootstrap struct{}

// The following method will be executed after system initialization
func(CustomeBootstrap) Start() error {return nil}
// The following method will be executed after system stop
func(CustomeBootstrap) Stop() {}

func init() {
	// Add to startup bootstrap queue
	bootstrap.AddBootstrap(&CustomeBootstrap{})
}

Example

You can refer tohttps://github.com/asjard/asjard/blob/main/pkg/stores/xgorm/xgorm.go

// DBManager data connection maintenance
type DBManager struct {
	dbs sync.Map
}

// Bootstrap connect to the database
func (m *DBManager) Bootstrap() error {
	logger.Debug("store gorm start")
	conf, err := m.loadAndWatchConfig()
	if err != nil {
		return err
	}
	return m.connDBs(conf)
}

// Shutdown disconnect from the database
func (m *DBManager) Shutdown() {
	m.dbs.Range(func(key, value any) bool {
		conn, ok := value.(*DBConn)
		if ok {
			sqlDB, err := conn.db.DB()
			if err == nil {
				sqlDB.Close()
			}
			m.dbs.Delete(key)
		}
		return true
	})
}

Initiator

Executed after local configuration files are loaded

Add to initialization queue

import "github.com/asjard/asjard/core/bootstrap"

// ClientManager client connection maintenance
type ClientManager struct {
	clients sync.Map
}

func (m *ClientManager) Start() error {
	clients, err := m.loadAndWatchConfig()
	if err != nil {
		return err
	}
	return m.newClients(clients)
}

func (m *ClientManager) Stop() {
	m.clients.Range(func(key, value any) bool {
		conn, ok := value.(*ClientConn)
		if ok {
			if err := conn.client.Close(); err != nil {
				logger.Error("close etcd client fail", "client", conn.name, "err", err)
			}
			m.clients.Delete(key)
		}
		return true
	})
}

func init() {
	clientManager = &ClientManager{}
	bootstrap.AddInitiator(clientManager)
}

You can refer toetcd connectionImplement