refactor: axios component (#4231)

* refactor: axios组件结构调整，代码优化

* chore: update

---------

Co-authored-by: 142vip <[email protected]>

packages/axios/src/config.default.ts

@@ -0,0 +1,6 @@
+/**
+ * 默认配置
+ */
+export default {
+  axios: {},
+};

packages/axios/src/configuration.ts

@@ -1,13 +1,12 @@
-import { Configuration } from '@midwayjs/core';
-import { HttpServiceFactory } from './serviceManager';
+import { Configuration, IMidwayContainer } from '@midwayjs/core';
+import ConfigDefault from './config.default';
+import { HttpServiceFactory } from './http-service.factory';
 
 @Configuration({
   namespace: 'axios',
   importConfigs: [
     {
-      default: {
-        axios: {},
-      },
+      default: ConfigDefault,
     },
   ],
   importConfigFilter: config => {
@@ -31,7 +30,7 @@ import { HttpServiceFactory } from './serviceManager';
   },
 })
 export class AxiosConfiguration {
-  async onReady(container) {
+  public async onReady(container: IMidwayContainer): Promise<void> {
     await container.getAsync(HttpServiceFactory);
   }
 }

packages/axios/src/http-service.factory.ts

@@ -0,0 +1,40 @@
+import {
+  Config,
+  Init,
+  Provide,
+  Scope,
+  ScopeEnum,
+  ServiceFactory,
+} from '@midwayjs/core';
+import axios, { AxiosInstance, CreateAxiosDefaults } from 'axios';
+
+@Provide()
+@Scope(ScopeEnum.Singleton)
+export class HttpServiceFactory extends ServiceFactory<AxiosInstance> {
+  @Config('axios')
+  axiosConfig: any;
+
+  @Init()
+  async init() {
+    let axiosConfig = this.axiosConfig;
+    if (!this.axiosConfig['clients']) {
+      axiosConfig = {
+        default: {},
+        clients: {
+          default: this.axiosConfig,
+        },
+      };
+    }
+    await this.initClients(axiosConfig);
+  }
+  public getName(): string {
+    return 'axios';
+  }
+
+  protected async createClient(
+    config: CreateAxiosDefaults,
+    clientName: string
+  ): Promise<AxiosInstance> {
+    return axios.create(config);
+  }
+}

packages/axios/src/serviceManager.ts → packages/axios/src/http-service.ts

@@ -1,62 +1,31 @@
-import type {
-  AxiosInstance,
-  AxiosRequestConfig,
-  AxiosResponse,
-  CreateAxiosDefaults,
-} from 'axios';
-import axios from 'axios';
 import {
-  Config,
   Init,
   Inject,
+  MidwayCommonError,
   Provide,
   Scope,
   ScopeEnum,
-  MidwayCommonError,
-  ServiceFactory,
 } from '@midwayjs/core';
-import { AxiosHttpService } from './interface';
-
-@Provide()
-@Scope(ScopeEnum.Singleton)
-export class HttpServiceFactory extends ServiceFactory<AxiosInstance> {
-  @Config('axios')
-  axiosConfig;
-
-  @Init()
-  async init() {
-    let axiosConfig = this.axiosConfig;
-    if (!this.axiosConfig['clients']) {
-      axiosConfig = {
-        default: {},
-        clients: {
-          default: this.axiosConfig,
-        },
-      };
-    }
-    await this.initClients(axiosConfig);
-  }
-
-  protected async createClient(
-    config: CreateAxiosDefaults,
-    clientName: any
-  ): Promise<AxiosInstance> {
-    return axios.create(config);
-  }
-
-  getName(): string {
-    return 'axios';
-  }
-}
+import { Axios, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+import { HttpServiceFactory } from './http-service.factory';
 
 @Provide()
 @Scope(ScopeEnum.Singleton)
-export class HttpService implements AxiosHttpService {
+export class HttpService implements Axios {
   private instance: AxiosInstance;
 
   @Inject()
   private serviceFactory: HttpServiceFactory;
 
+  @Init()
+  protected async init() {
+    const clientName = this.serviceFactory.getDefaultClientName() || 'default';
+
+    this.instance = this.serviceFactory.get(clientName);
+    if (!this.instance) {
+      throw new MidwayCommonError('axios default instance not found.');
+    }
+  }
   get defaults() {
     return this.instance.defaults;
   }
@@ -65,16 +34,6 @@ export class HttpService implements AxiosHttpService {
     return this.instance.interceptors;
   }
 
-  @Init()
-  protected async init() {
-    this.instance = this.serviceFactory.get(
-      this.serviceFactory.getDefaultClientName?.() || 'default'
-    );
-    if (!this.instance) {
-      throw new MidwayCommonError('axios default instance not found.');
-    }
-  }
-
   getUri(config?: AxiosRequestConfig): string {
     return this.instance.getUri(config);
   }

packages/axios/src/index.ts

@@ -2,12 +2,12 @@ import axios from 'axios';
 import * as Axios from 'axios';
 
 export { AxiosConfiguration as Configuration } from './configuration';
-export * from './interface';
-export * from './serviceManager';
+export * from './http-service.factory';
+export * from './http-service';
 export {
   /**
    * @deprecated Use `Axios` directly
    */
   axios,
+  Axios,
 };
-export { Axios };

packages/axios/test/fixtures/base-app/package.json

@@ -1,6 +1,5 @@
 {
   "name": "base-app",
   "version": "1.0.0",
-  "dependencies": {
-  }
+  "dependencies": {}
 }

packages/axios/test/fixtures/base-app/src/configuration.ts

@@ -5,6 +5,4 @@ import { Configuration } from '@midwayjs/core';
     require('../../../../src')
   ]
 })
-export class AutoConfiguration {
-
-}
+export class AutoConfiguration {}

packages/axios/test/index.test.ts

@@ -67,7 +67,7 @@ describe('/test/index.test.ts', () => {
     }
   });
 
-  it('should test defaults and intercepters', () => {
+  it('should test defaults and interceptors', () => {
     expect(httpService.defaults).toStrictEqual(axios.defaults);
     expect(httpService.interceptors).toStrictEqual(axios.interceptors);
   });