comment patch for #233

pkg/logic/logic.go

@@ -47,7 +47,6 @@ type ILalServer interface {
 // NewLalServer 创建一个lal server
 //
 // @param modOption: 定制化配置。可变参数，如果不关心，可以不填，具体字段见 Option
-//
 func NewLalServer(modOption ...ModOption) ILalServer {
 	return NewServerManager(modOption...)
 }
@@ -66,7 +65,6 @@ type ICustomizePubSessionContext interface {
 // ---------------------------------------------------------------------------------------------------------------------
 
 // INotifyHandler 事件通知接口
-//
 type INotifyHandler interface {
 	OnServerStart(info base.LalInfo)
 	OnUpdate(info base.UpdateInfo)
@@ -81,11 +79,16 @@ type INotifyHandler interface {
 }
 
 type Option struct {
-	// ConfFilename 配置文件，注意，如果为空，内部会尝试从 DefaultConfFilenameList 读取默认配置文件
+	// ConfFilename 配置文件。
 	//
+	// 注意，如果为空，内部会尝试从 DefaultConfFilenameList 读取默认配置文件
 	ConfFilename string
 
-	// ConfRawContent 配置，JSON格式
+	// ConfRawContent 配置内容，json格式。
+	//
+	// 应用场景：有的业务方配置内容并非从配置文件中读取，比如集成 ILalServer 时配置内容来自配置中心网络下发，所以提供这个字段供业务方直接传入配置内容。
+	//
+	// 注意，读取加载配置的优先级是 ConfRawContent > ConfFilename > DefaultConfFilenameList
 	ConfRawContent []byte
 
 	// NotifyHandler
@@ -117,7 +120,6 @@ var defaultOption = Option{
 type ModOption func(option *Option)
 
 // DefaultConfFilenameList 没有指定配置文件时，按顺序作为优先级，找到第一个存在的并使用
-//
 var DefaultConfFilenameList = []string{
 	filepath.FromSlash("lalserver.conf.json"),
 	filepath.FromSlash("./conf/lalserver.conf.json"),