@dangao/bun-server 1.8.1 → 1.8.3

package/docs/microservice-config-center.md

@@ -1,29 +1,29 @@
-# 配置中心使用指南
+# Configuration Center Usage Guide
 
-本文档介绍如何使用 Bun Server Framework 的配置中心功能。
+This document introduces how to use the configuration center feature in Bun Server Framework.
 
-## 目录
+## Table of Contents
 
-- [概述](#概述)
-- [快速开始](#快速开始)
-- [基本使用](#基本使用)
-- [配置热更新](#配置热更新)
-- [ConfigModule 集成](#configmodule-集成)
-- [装饰器使用](#装饰器使用)
-- [最佳实践](#最佳实践)
+- [Overview](#overview)
+- [Quick Start](#quick-start)
+- [Basic Usage](#basic-usage)
+- [Hot Configuration Update](#hot-configuration-update)
+- [ConfigModule Integration](#configmodule-integration)
+- [Decorator Usage](#decorator-usage)
+- [Best Practices](#best-practices)
 
-## 概述
+## Overview
 
-配置中心提供了集中式配置管理能力，支持：
+The configuration center provides centralized configuration management capabilities, supporting:
 
-- **动态配置**：从配置中心获取配置，支持配置热更新
-- **多环境支持**：通过命名空间和分组管理不同环境的配置
-- **配置优先级**：配置中心配置 > 环境变量 > 默认配置
-- **配置监听**：监听配置变更，自动刷新应用配置
+- **Dynamic Configuration**: Fetch configurations from the configuration center with hot update support
+- **Multi-Environment Support**: Manage configurations for different environments through namespaces and groups
+- **Configuration Priority**: Config center > Environment variables > Default configuration
+- **Configuration Watching**: Watch for configuration changes and automatically refresh application configuration
 
-## 快速开始
+## Quick Start
 
-### 1. 注册配置中心模块
+### 1. Register Configuration Center Module
 
 ```typescript
 import { Application } from '@dangao/bun-server';
@@ -41,13 +41,13 @@ app.registerModule(
         username: 'nacos',
         password: 'nacos',
       },
-      watchInterval: 3000, // 配置轮询间隔（毫秒）
+      watchInterval: 3000, // Configuration polling interval (milliseconds)
     },
   }),
 );
 ```
 
-### 2. 使用配置中心
+### 2. Use Configuration Center
 
 ```typescript
 import {
@@ -72,15 +72,15 @@ class MyService {
 }
 ```
 
-## 基本使用
+## Basic Usage
 
-### 获取配置
+### Get Configuration
 
 ```typescript
-// 基本用法
+// Basic usage
 const config = await configCenter.getConfig('my-config', 'DEFAULT_GROUP');
 
-// 指定命名空间
+// Specify namespace
 const config = await configCenter.getConfig(
   'my-config',
   'DEFAULT_GROUP',
@@ -88,20 +88,20 @@ const config = await configCenter.getConfig(
 );
 ```
 
-### 配置结果
+### Configuration Result
 
-`getConfig` 返回 `ConfigResult` 对象：
+`getConfig` returns a `ConfigResult` object:
 
 ```typescript
 interface ConfigResult {
-  content: string;        // 配置内容
-  md5: string;           // 配置 MD5（用于判断是否变更）
-  lastModified: number;  // 最后修改时间（时间戳）
-  contentType: string;   // 内容类型
+  content: string;        // Configuration content
+  md5: string;           // Configuration MD5 (for change detection)
+  lastModified: number;  // Last modified time (timestamp)
+  contentType: string;   // Content type
 }
 ```
 
-### 监听配置变更
+### Watch Configuration Changes
 
 ```typescript
 const unsubscribe = configCenter.watchConfig(
@@ -109,37 +109,37 @@ const unsubscribe = configCenter.watchConfig(
   'DEFAULT_GROUP',
   (newConfig) => {
     console.log('Config updated:', newConfig.content);
-    // 更新应用配置
+    // Update application configuration
     updateAppConfig(JSON.parse(newConfig.content));
   },
 );
 
-// 取消监听
+// Unsubscribe
 unsubscribe();
 ```
 
-## 配置热更新
+## Hot Configuration Update
 
-配置中心支持配置热更新，通过轮询机制检测配置变更：
+The configuration center supports hot configuration updates through a polling mechanism to detect configuration changes:
 
 ```typescript
 ConfigCenterModule.forRoot({
   provider: 'nacos',
   nacos: {
-    watchInterval: 3000, // 每 3 秒检查一次配置变更
+    watchInterval: 3000, // Check for configuration changes every 3 seconds
   },
 });
 
-// 监听配置变更
+// Watch configuration changes
 configCenter.watchConfig('my-config', 'DEFAULT_GROUP', (newConfig) => {
-  // 配置变更时自动调用
+  // Automatically called when configuration changes
   console.log('Config hot updated:', newConfig.content);
 });
 ```
 
-## ConfigModule 集成
+## ConfigModule Integration
 
-ConfigModule 支持与配置中心深度集成，配置变更会自动刷新 ConfigService：
+ConfigModule supports deep integration with the configuration center, automatically refreshing ConfigService when configurations change:
 
 ```typescript
 import { ConfigModule } from '@dangao/bun-server';
@@ -157,11 +157,11 @@ ConfigModule.forRoot({
       ['app.name', { dataId: 'app-name', groupName: 'DEFAULT_GROUP' }],
       ['app.port', { dataId: 'app-port', groupName: 'DEFAULT_GROUP' }],
     ]),
-    configCenterPriority: true, // 配置中心配置优先级最高
+    configCenterPriority: true, // Config center has highest priority
   },
 });
 
-// 使用 ConfigService
+// Use ConfigService
 import { CONFIG_SERVICE_TOKEN, ConfigService } from '@dangao/bun-server';
 
 @Injectable()
@@ -171,22 +171,22 @@ class MyService {
   ) {}
 
   public getAppName() {
-    // 自动从配置中心获取，配置变更时自动更新
+    // Automatically fetched from config center, auto-updated on changes
     return this.config.get<string>('app.name');
   }
 }
 ```
 
-### 配置优先级
+### Configuration Priority
 
-- `configCenterPriority: true`（默认）：配置中心 > 环境变量 > 默认配置
-- `configCenterPriority: false`：默认配置 > 环境变量 > 配置中心
+- `configCenterPriority: true` (default): Config center > Environment variables > Default configuration
+- `configCenterPriority: false`: Default configuration > Environment variables > Config center
 
-## 装饰器使用
+## Decorator Usage
 
 ### @ConfigCenterValue
 
-自动注入配置值：
+Automatically inject configuration values:
 
 ```typescript
 import { ConfigCenterValue, Injectable } from '@dangao/bun-server';
@@ -195,19 +195,19 @@ import { ConfigCenterValue, Injectable } from '@dangao/bun-server';
 class MyService {
   @ConfigCenterValue('app-name', 'DEFAULT_GROUP', {
     defaultValue: 'MyApp',
-    watch: true, // 监听配置变更
+    watch: true, // Watch for configuration changes
   })
   public appName: string = '';
 
   public getAppName() {
-    return this.appName; // 自动从配置中心获取
+    return this.appName; // Automatically fetched from config center
   }
 }
 ```
 
 ### @NacosValue
 
-Nacos 特定的配置值注入（便捷别名）：
+Nacos-specific configuration value injection (convenience alias):
 
 ```typescript
 import { NacosValue, Injectable } from '@dangao/bun-server';
@@ -221,38 +221,37 @@ class MyService {
 }
 ```
 
-## 最佳实践
+## Best Practices
 
-### 1. 配置组织
+### 1. Configuration Organization
 
-- **命名空间**：用于区分不同环境（dev、test、prod）
-- **分组**：用于逻辑分组（DEFAULT_GROUP、DATABASE_GROUP 等）
-- **DataId**：配置的唯一标识
+- **Namespace**: Used to distinguish different environments (dev, test, prod)
+- **Group**: Used for logical grouping (DEFAULT_GROUP, DATABASE_GROUP, etc.)
+- **DataId**: Unique identifier for configuration
 
-### 2. 配置格式
+### 2. Configuration Format
 
-- 推荐使用 JSON 格式存储配置
-- 支持纯文本配置（如 properties、yaml 等）
+- Recommended to use JSON format for storing configurations
+- Supports plain text configurations (such as properties, yaml, etc.)
 
-### 3. 配置监听
+### 3. Configuration Watching
 
-- 为关键配置启用监听（`watch: true`）
-- 配置变更时及时更新应用状态
-- 避免频繁的配置变更
+- Enable watching for critical configurations (`watch: true`)
+- Update application state promptly when configurations change
+- Avoid frequent configuration changes
 
-### 4. 错误处理
+### 4. Error Handling
 
-- 配置获取失败时使用默认值
-- 记录配置获取错误日志
-- 实现配置降级策略
+- Use default values when configuration fetch fails
+- Log configuration fetch errors
+- Implement configuration fallback strategies
 
-### 5. 性能优化
+### 5. Performance Optimization
 
-- 合理设置 `watchInterval`（建议 3-10 秒）
-- 使用配置缓存减少 API 调用
-- 批量获取配置（如果支持）
+- Set `watchInterval` reasonably (recommended 3-10 seconds)
+- Use configuration caching to reduce API calls
+- Batch fetch configurations (if supported)
 
-## 示例
-
-完整示例请参考 `examples/microservice-app.ts`。
+## Examples
 
+For complete examples, please refer to `examples/microservice-app.ts`.

package/docs/microservice-nacos.md

@@ -1,40 +1,40 @@
-# Nacos 集成文档
+# Nacos Integration Documentation
 
-本文档介绍如何在 Bun Server Framework 中使用 Nacos 作为配置中心和服务注册中心。
+This document introduces how to use Nacos as a configuration center and service registry in Bun Server Framework.
 
-## 目录
+## Table of Contents
 
-- [概述](#概述)
-- [Nacos 安装](#nacos-安装)
-- [配置中心集成](#配置中心集成)
-- [服务注册中心集成](#服务注册中心集成)
-- [完整示例](#完整示例)
-- [常见问题](#常见问题)
+- [Overview](#overview)
+- [Nacos Installation](#nacos-installation)
+- [Configuration Center Integration](#configuration-center-integration)
+- [Service Registry Integration](#service-registry-integration)
+- [Complete Example](#complete-example)
+- [Common Issues](#common-issues)
 
-## 概述
+## Overview
 
-Bun Server Framework 通过 `@dangao/nacos-client` 包提供 Nacos 3.X 支持，包括：
+Bun Server Framework provides Nacos 3.X support through the `@dangao/nacos-client` package, including:
 
-- **配置管理**：动态配置获取和监听
-- **服务注册**：服务实例注册、续约、注销
-- **服务发现**：服务实例查询和监听
-- **Open API**：基于 Nacos 3.X Open API 实现
+- **Configuration Management**: Dynamic configuration fetching and watching
+- **Service Registration**: Service instance registration, renewal, and deregistration
+- **Service Discovery**: Service instance querying and watching
+- **Open API**: Based on Nacos 3.X Open API implementation
 
-## Nacos 安装
+## Nacos Installation
 
-### Docker 安装（推荐）
+### Docker Installation (Recommended)
 
 ```bash
 docker run --name nacos -e MODE=standalone -p 8848:8848 nacos/nacos-server:v3.0.0
 ```
 
-### 访问控制台
+### Access Console
 
-访问 http://localhost:8848/nacos，默认用户名/密码：`nacos/nacos`
+Visit http://localhost:8848/nacos, default username/password: `nacos/nacos`
 
-## 配置中心集成
+## Configuration Center Integration
 
-### 1. 注册配置中心模块
+### 1. Register Configuration Center Module
 
 ```typescript
 import { Application } from '@dangao/bun-server';
@@ -52,21 +52,21 @@ app.registerModule(
         username: 'nacos',
         password: 'nacos',
       },
-      watchInterval: 3000, // 配置轮询间隔（毫秒）
+      watchInterval: 3000, // Configuration polling interval (milliseconds)
     },
   }),
 );
 ```
 
-### 2. 在 Nacos 控制台创建配置
+### 2. Create Configuration in Nacos Console
 
-1. 登录 Nacos 控制台
-2. 进入"配置管理" -> "配置列表"
-3. 点击"+"创建配置：
-   - **Data ID**：`my-config`
-   - **Group**：`DEFAULT_GROUP`
-   - **配置格式**：`JSON`（或其他格式）
-   - **配置内容**：
+1. Log in to Nacos console
+2. Go to "Configuration Management" -> "Configuration List"
+3. Click "+" to create configuration:
+   - **Data ID**: `my-config`
+   - **Group**: `DEFAULT_GROUP`
+   - **Configuration Format**: `JSON` (or other formats)
+   - **Configuration Content**:
      ```json
      {
        "app": {
@@ -76,7 +76,7 @@ app.registerModule(
      }
      ```
 
-### 3. 使用配置
+### 3. Use Configuration
 
 ```typescript
 import {
@@ -102,18 +102,18 @@ class MyService {
 }
 ```
 
-### 4. 配置热更新
+### 4. Hot Configuration Update
 
 ```typescript
 configCenter.watchConfig('my-config', 'DEFAULT_GROUP', (newConfig) => {
   console.log('Config updated:', newConfig.content);
-  // 更新应用配置
+  // Update application configuration
 });
 ```
 
-## 服务注册中心集成
+## Service Registry Integration
 
-### 1. 注册服务注册中心模块
+### 1. Register Service Registry Module
 
 ```typescript
 import { ServiceRegistryModule } from '@dangao/bun-server';
@@ -128,15 +128,15 @@ app.registerModule(
         username: 'nacos',
         password: 'nacos',
       },
-      heartbeatInterval: 5000, // 心跳间隔（毫秒）
+      heartbeatInterval: 5000, // Heartbeat interval (milliseconds)
     },
   }),
 );
 ```
 
-### 2. 注册服务
+### 2. Register Service
 
-#### 使用装饰器（推荐）
+#### Using Decorator (Recommended)
 
 ```typescript
 import { ServiceRegistry, Controller, GET } from '@dangao/bun-server';
@@ -156,10 +156,10 @@ class UserController {
 
 app.registerController(UserController);
 await app.listen(3000);
-// 服务会自动注册到 Nacos
+// Service will be automatically registered to Nacos
 ```
 
-#### 手动注册
+#### Manual Registration
 
 ```typescript
 import {
@@ -186,7 +186,7 @@ class MyService {
 }
 ```
 
-### 3. 服务发现
+### 3. Service Discovery
 
 ```typescript
 import {
@@ -199,13 +199,13 @@ const instances = await serviceRegistry.getInstances('user-service', {
   namespaceId: 'public',
 });
 
-// 监听服务实例变更
+// Watch for service instance changes
 serviceRegistry.watchInstances('user-service', (newInstances) => {
   console.log('Instances updated:', newInstances);
 });
 ```
 
-## 完整示例
+## Complete Example
 
 ```typescript
 import { Application, Controller, GET, Injectable, Inject } from '@dangao/bun-server';
@@ -219,7 +219,7 @@ import {
   type ServiceRegistry,
 } from '@dangao/bun-server';
 
-// 注册配置中心
+// Register configuration center
 ConfigCenterModule.forRoot({
   provider: 'nacos',
   nacos: {
@@ -232,7 +232,7 @@ ConfigCenterModule.forRoot({
   },
 });
 
-// 注册服务注册中心
+// Register service registry
 ServiceRegistryModule.forRoot({
   provider: 'nacos',
   nacos: {
@@ -245,7 +245,7 @@ ServiceRegistryModule.forRoot({
   },
 });
 
-// 服务类
+// Service class
 @Injectable()
 class UserService {
   private readonly serviceClient: ServiceClient;
@@ -266,7 +266,7 @@ class UserService {
   }
 }
 
-// 控制器
+// Controller
 @ServiceRegistry('user-service', { port: 3000 })
 @Controller('/api/users')
 class UserController {
@@ -278,69 +278,68 @@ class UserController {
   }
 }
 
-// 启动应用
+// Start application
 const app = new Application();
 app.registerController(UserController);
 await app.listen(3000);
 ```
 
-## 常见问题
+## Common Issues
 
-### 1. 连接失败
+### 1. Connection Failure
 
-**问题**：无法连接到 Nacos 服务器
+**Issue**: Unable to connect to Nacos server
 
-**解决方案**：
-- 检查 Nacos 服务器是否运行
-- 检查 `serverList` 配置是否正确
-- 检查网络连接和防火墙设置
-- 检查用户名和密码是否正确
+**Solutions**:
+- Check if Nacos server is running
+- Check if `serverList` configuration is correct
+- Check network connection and firewall settings
+- Check if username and password are correct
 
-### 2. 配置获取失败
+### 2. Configuration Fetch Failure
 
-**问题**：无法获取配置
+**Issue**: Unable to fetch configuration
 
-**解决方案**：
-- 检查配置是否在 Nacos 控制台中存在
-- 检查 Data ID 和 Group 是否正确
-- 检查命名空间是否正确
-- 检查权限设置
+**Solutions**:
+- Check if configuration exists in Nacos console
+- Check if Data ID and Group are correct
+- Check if namespace is correct
+- Check permission settings
 
-### 3. 服务注册失败
+### 3. Service Registration Failure
 
-**问题**：服务无法注册到 Nacos
+**Issue**: Service cannot be registered to Nacos
 
-**解决方案**：
-- 检查服务注册中心模块是否已注册
-- 检查服务名、IP、端口是否正确
-- 检查 Nacos 服务器连接是否正常
-- 查看应用日志获取详细错误信息
+**Solutions**:
+- Check if service registry module is registered
+- Check if service name, IP, and port are correct
+- Check if Nacos server connection is normal
+- Check application logs for detailed error information
 
-### 4. 服务发现为空
+### 4. Service Discovery Returns Empty
 
-**问题**：服务发现返回空列表
+**Issue**: Service discovery returns empty list
 
-**解决方案**：
-- 检查服务是否已注册
-- 检查 `healthyOnly` 选项（如果设置为 true，只返回健康实例）
-- 检查命名空间和分组是否正确
-- 检查服务实例是否健康
+**Solutions**:
+- Check if service is registered
+- Check `healthyOnly` option (if set to true, only healthy instances are returned)
+- Check if namespace and group are correct
+- Check if service instances are healthy
 
-### 5. 配置热更新不生效
+### 5. Hot Configuration Update Not Working
 
-**问题**：配置变更后应用未更新
+**Issue**: Application not updated after configuration changes
 
-**解决方案**：
-- 检查是否启用了配置监听（`watch: true`）
-- 检查 `watchInterval` 设置是否合理
-- 检查配置监听回调是否正确实现
-- 查看日志确认配置变更是否被检测到
+**Solutions**:
+- Check if configuration watching is enabled (`watch: true`)
+- Check if `watchInterval` setting is reasonable
+- Check if configuration watch callback is correctly implemented
+- Check logs to confirm if configuration changes are detected
 
-## 参考资源
+## Reference Resources
 
-- [Nacos 官方文档](https://nacos.io/docs/latest/)
+- [Nacos Official Documentation](https://nacos.io/docs/latest/)
 - [Nacos 3.X Open API](https://nacos.io/docs/latest/manual/user/open-api/)
-- [微服务使用指南](./microservice.md)
-- [配置中心使用指南](./microservice-config-center.md)
-- [服务注册与发现使用指南](./microservice-service-registry.md)
-
+- [Microservice Usage Guide](./microservice.md)
+- [Configuration Center Usage Guide](./microservice-config-center.md)
+- [Service Registration and Discovery Usage Guide](./microservice-service-registry.md)