Merge pull request #3 from ddzyan/feat/bill

docs(完善单元测试): 📃

Author: helloHT

.github/workflows/npm-publish.yml

@@ -1 +1,26 @@
-midway的apollo组件
+# 前言
+
+midway 携程异步配置中心 apollo 组件
+
+Apollo（阿波罗）是携程框架部门研发的分布式配置中心，能够集中化管理应用不同环境、不同集群的配置，配置修改后能够实时推送到应用端，并且具备规范的权限、流程治理等特性，适用于微服务配置管理场景。
+
+底层依赖 @lvgithub/ctrip-apollo-client 模块包
+
+# 使用
+
+## 初始化配置介绍
+
+- metaServerUrl string meta server 地址,负载均衡获取 config server 地址
+- configServerUrl string config server 地址，配置了 metaServerUrl 本项可以不配置
+- appId string required 应用的 appId
+- accessKey string Apollo AccessKey
+- clusterName string 集群名,默认值:default
+- namespaceList array Namespace 的名字,默认值:[application]
+- configPath string 本地配置文件路径 默认值./config/apolloConfig.json
+- logger object 日志类 必须实现 logger.info(),logger.error() 两个方法
+
+## 使用
+
+@HotValue() 获取具体的配置字段，封装 getter(热更新)
+
+@GetValue() 直接获取具体的配置字段

README.md

@@ -1,6 +1,6 @@
 {
   "name": "midway-apollo",
-  "version": "1.0.16",
+  "version": "1.1.1",
   "description": "",
   "main": "dist/index.js",
   "typings": "index.d.ts",

package.json

@@ -2,7 +2,7 @@ import { Configuration, Inject, Init } from '@midwayjs/decorator';
 import { MidwayDecoratorService } from '@midwayjs/core';
 
 import { ApolloServiceFactory, ApolloService } from './manager';
-import { APOLLO } from './decorator';
+import { HOT_VALUE, GET_VALUE } from './decorator';
 
 @Configuration({
   namespace: 'apollo',
@@ -25,11 +25,18 @@ export class ApolloConfiguration {
   async init() {
     // 实现装饰器
     this.decoratorService.registerPropertyHandler(
-      APOLLO,
+      HOT_VALUE,
       (propertyName, meta) => {
         return this.apolloService.hotValue(meta.key).value;
       }
     );
+
+    this.decoratorService.registerPropertyHandler(
+      GET_VALUE,
+      (propertyName, meta) => {
+        return this.apolloService.getValue(meta.key);
+      }
+    );
   }
 
   async onReady(container) {

src/configuration.ts

@@ -1,11 +1,17 @@
-// src/decorator/memoryCache.decorator.ts
 import { createCustomPropertyDecorator } from '@midwayjs/decorator';
 
 // 装饰器内部的唯一 id
-export const APOLLO = 'decorator:apollo';
+export const HOT_VALUE = 'apollo:hotValue';
+export const GET_VALUE = 'apollo:getValue';
 
-export function Apollo(key?: string): PropertyDecorator {
-  return createCustomPropertyDecorator(APOLLO, {
+export function HotValue(key?: string): PropertyDecorator {
+  return createCustomPropertyDecorator(HOT_VALUE, {
+    key,
+  });
+}
+
+export function GetValue(key?: string): PropertyDecorator {
+  return createCustomPropertyDecorator(GET_VALUE, {
     key,
   });
 }

src/decorator.ts

@@ -36,7 +36,7 @@ export class ApolloServiceFactory extends ServiceFactory<CtripApolloClient> {
       return client;
     } catch (error) {
       this.logger.error('[midway:apollo] client error: %s', error);
-      return;
+      throw error;
     }
   }
 

src/manager.ts

@@ -1,8 +1,9 @@
 export const apollo = {
   client: {
-    metaServerUrl: 'http://106.54.227.205:8080',
-    appId: 'apolloclient',
-    accessKey: '35be8a4868c748ec96faef3e326adad5',
+    appId: 'midway-apollo',
+    accessKey: '36104c4b15784a7b97708435ef97ee27',
     configPath: './config/apolloConfig.json',
+    namespaceList: ['application'],
+    configServerUrl: 'http://106.54.227.205:8080',
   },
 };

test/base-app-single-client/src/config.default.ts

@@ -0,0 +1,26 @@
+import { Provide } from '@midwayjs/decorator';
+import { HotValue, GetValue } from '../../../../src/decorator';
+
+@Provide()
+export class UserService {
+  @HotValue('name')
+  private name: string;
+
+  @HotValue('className:三年二班')
+  private className: string;
+
+  @GetValue('age')
+  private age: string;
+
+  getName() {
+    return this.name;
+  }
+
+  getClassName() {
+    return this.className;
+  }
+
+  getAge() {
+    return this.age;
+  }
+}

test/base-app-single-client/src/service/user.ts

@@ -1,25 +1,46 @@
 import { join } from 'path';
-
 import { close, createLightApp } from '@midwayjs/mock';
 
-import { ApolloService } from '../src';
+import { UserService } from './base-app-single-client/src/service/user';
 
 describe('/test/index.test.ts', () => {
   let app;
 
+  beforeAll(async () => {
+    app = await createLightApp(join(__dirname, './base-app-single-client'));
+  });
+
   afterAll(async () => {
     await close(app);
   });
 
-  it('test single client', async () => {
-    app = await createLightApp(join(__dirname, './base-app-single-client'));
-    const apolloService = await app
+  it('test hot value', async () => {
+    const userService: UserService = await app
+      .getApplicationContext()
+      .getAsync(UserService);
+
+    const name = userService.getName();
+
+    expect(name).toEqual('张飞');
+  });
+
+  it('test hot value default Value', async () => {
+    const userService: UserService = await app
+      .getApplicationContext()
+      .getAsync(UserService);
+
+    const className = userService.getClassName();
+
+    expect(className).toEqual('三年二班');
+  });
+
+  it('test get value', async () => {
+    const userService: UserService = await app
       .getApplicationContext()
-      .getAsync(ApolloService);
+      .getAsync(UserService);
+
+    const age = userService.getAge();
 
-    expect(apolloService.hotValue('mysql.port:3306').value).toBe('3306');
-    expect(apolloService.hotValue('mysql.host:127.0.0.1').value).toBe(
-      '127.0.0.1'
-    );
+    expect(age).toEqual('13');
   });
 });