boot

Boot Package Improvement Documentation

Overview

The boot package is responsible for the bootstrap and startup process of Lynx applications. After refactoring, we have improved the code naming, structure, and error handling to make it clearer and more robust.

File Structure

1. application.go - Application Startup Management

• Function: Manages the complete lifecycle of the application
• Main Components:
  • Application struct: The main bootstrap structure of the application
  • Run() method: Starts the application and manages the lifecycle
  • handlePanic() method: Handles panics and ensures resource cleanup
  • NewApplication() function: Creates a new application instance

2. configuration.go - Configuration Loading and Validation

• Function: Responsible for loading, validating, and managing configuration files
• Main Components:
  • LoadBootstrapConfig() method: Loads bootstrap configuration
  • validateConfig() method: Validates configuration integrity
  • setupConfigCleanup() method: Sets up configuration cleanup
  • GetName(), GetHost(), GetVersion() methods: Gets application information

3. config_manager.go - Configuration Path Management

• Function: Manages configuration paths, avoiding the use of global variables
• Main Components:
  • ConfigManager struct: Configuration manager (singleton pattern)
  • GetConfigManager() function: Gets the configuration manager instance
  • SetConfigPath(), GetConfigPath() methods: Manages configuration paths
  • GetDefaultConfigPath() method: Gets the default configuration path

Major Improvements

1. Naming Optimization

• Original Names: strap.go, conf.go, config.go
• New Names: application.go, configuration.go, config_manager.go
• Improvement: Makes naming more intuitive with clearer domains

2. Configuration Path Handling Optimization

• Original Issue: Hard-coded default path "../../configs"
• New Solution:
  • Supports environment variable LYNX_CONFIG_PATH
  • Defaults to ./configs in the current directory
  • Unified management through configuration manager

3. Error Handling Improvement

• Original Issue: Only logged warnings when cleanup setup failed
• New Solution: Returns errors when cleanup setup fails to ensure proper resource management

4. Resource Cleanup Order Optimization

• Original Issue: Cleanup functions executed before panic handling
• New Solution: Handle panic first, then execute cleanup to avoid accessing uninitialized resources

5. Enhanced Error Messages

• Original Issue: Error messages were too simple
• New Solution: Provides more detailed error context information

6. Configuration Validation

• New Feature: Added configuration validation to ensure necessary configuration items exist
• Validation Items: lynx.name, lynx.version, lynx.host

7. Modularization Improvement

• Original Issue: Used global variable flagConf
• New Solution: Uses configuration manager to improve testability and modularity

Backward Compatibility

To maintain backward compatibility, we have retained the following aliases:

• type Boot = Application
• func NewLynxApplication() = NewApplication()

Usage Example

// Create application instance app := boot.NewApplication(wireFunc, plugins...)
// Start the application if err := app.Run(); err != nil { log.Fatal(err) }

Environment Variables

• LYNX_CONFIG_PATH: Sets the default configuration path
• Command-line argument -conf: Specifies the configuration file path

Test Support

The code includes test environment detection to avoid flag parsing conflicts during testing.