@csbj/ms-shared

CSBJ微服务共享组件库

功能特性

• ✅ 统一响应格式: 标准化的API响应格式
• ✅ 配置管理: 统一的配置服务
• ✅ 异常处理: 全局异常过滤器
• ✅ 工具类: 日期、字符串等常用工具
• ✅ 类型定义: 统一的TypeScript类型定义

快速开始

安装

# 作为NPM包安装
npm install @csbj/ms-shared

# 或者本地链接开发
npm link @csbj/ms-shared

使用

import { SharedModule, ResponseService, ConfigService } from '@csbj/ms-shared';

@Module({
  imports: [SharedModule.forRoot()],
})
export class AppModule {}

@Injectable()
export class AppService {
  constructor(
    private readonly responseService: ResponseService,
    private readonly configService: ConfigService,
  ) {}

  async getData(requestId: string) {
    const data = { message: 'Hello World' };
    return this.responseService.success(data, requestId);
  }
}

API 文档

ResponseService

success(data, requestId, correlationId?)

创建成功响应

error(errorCode, message, requestId, details?, correlationId?)

创建错误响应

paginated(data, pagination, requestId, correlationId?)

创建分页响应

legacySuccess(data, message?)

兼容现有格式的成功响应

legacyError(code, message, data?)

兼容现有格式的错误响应

Res 类（兼容现有格式）

Ok(message?)

创建成功响应

OkWithData(data, message?)

创建带数据的成功响应

OkWithPage(list, total, message?)

创建分页响应

OkWithList(list, message?)

创建列表响应

Fail(data, message?, type?)

创建失败响应

FailWithError(err, type?, data?)

创建错误响应

FailWithCode(code, data?, message?)

创建自定义错误码响应

Result 函数

Result(code, data, msg)

创建基础响应格式

ConfigService

get(key)

获取配置值

getServiceName()

获取服务名称

getServiceVersion()

获取服务版本

isDevelopment()

是否为开发环境

isProduction()

是否为生产环境

工具类

DateUtil

• format(date, format?): 格式化日期
• now(): 获取当前时间戳
• nowISO(): 获取当前ISO时间字符串

StringUtil

• random(length?): 生成随机字符串
• uuid(): 生成UUID
• capitalize(str): 首字母大写
• mask(str, start?, end?, maskChar?): 掩码处理

开发

# 安装依赖
npm install

# 构建
npm run build

# 监听构建
npm run build:watch

# 测试
npm test

许可证

MIT