Learning experience of replacing httpclientmodule with mockhttpclientmodule

Jincheng 2020-11-07 20:56:01
learning experience replacing httpclientmodule mockhttpclientmodule


Preface

The previous project testing used Stub Replace the original components for testing , Today's questionnaire system adopts a new idea , It's using MockHttpClientModule Replace HttpClientModule, The front and back interfaces are completely unified , Closer to the real request , This paper mainly summarizes the learning experience , Summarize the idea of this method .

Method

Let's first look at the method to be tested :

/**
* Through the test paper ID Get answers
* 1. If there is an unfinished answer sheet , Then return to the unfinished answer sheet
* 2. If there is no unfinished answer sheet , Then create a new answer sheet to return to
* @param id The examination paper ID
*/getByPaperId(id: number): Observable<AnswerSheet> {
return this.httpClient.get<AnswerSheet>(`${this.baseUrl}/${id}`);
}

The test method :

beforeEach(() => {
TestBed.configureTestingModule({
imports: [
MockApiModule
],
providers: [
MockHttpClient
]
});
service = TestBed.inject(AnswerSheetService);
});
it(' Test whether the simulated interface service works ', () => {
expect(service).toBeTruthy();
let called = false;
service.getByPaperId(123).subscribe(data => {
expect(data.id).toEqual(123);
called = true;
});
getTestScheduler().flush();
expect(called).toBeTrue();
});

MockHttpClient

export class MockHttpClient {
constructor(private mockApiService: MockApiService) {
}
get<T>(url: string, options?: {
headers?: HttpHeaders | {
[header: string]: string | string[];
};
params?: HttpParams | {
[param: string]: string | string[];
};
}): Observable<T> {
return this.mockApiService.get<T>(url, options);
}

MockApiService

get Method

/**
* get Method * @param url Request address
* @param options Options
*/
get<T>(url: string, options = {} as {
headers?: HttpHeaders | {
[header: string]: string | string[];
};
params?: HttpParams | {
[param: string]: string | string[];
};
}): Observable<T> {
return this.request<T>('get', url, {
observe: 'response',
responseType: 'json',
headers: options.headers,
params: options.params
});
}
}

request

/**
* be-all GETPOSTDELETEPUTPATCH Methods eventually call request Method . * If at present request Can't meet demand , Please move on angular Official HttpClient * * The method is based on method Match , Then according to URL Matching regular expressions . * After the matching is successful, the parameters are passed into the interface and the return value of the analog interface is obtained * * @param method Request method
* @param url Request address
* @param options Options
*/
request<R>(method: string, url: string, options: {
body?: any;
headers?: HttpHeaders | {
[header: string]: string | string[];
};
reportProgress?: boolean;
observe: 'response';
params?: HttpParams | {
[param: string]: string | string[];
};
responseType?: 'json';
withCredentials?: boolean;
}): Observable<R> {
let result = null as R;
let foundCount = 0;
const urlRecord = this.routers[method] as Record<string, RequestCallback<any>>;
for (const key in urlRecord) {
if (urlRecord.hasOwnProperty(key)) {
const reg = new RegExp(key);
if (reg.test(url)) {
const callback = urlRecord[key] as RequestCallback<R>;
callback(url.match(reg), options.params, options.headers, (body) => {
result = body;
foundCount++;
if (foundCount > 1) {
throw Error(' It matches more than one URL Information , Please verify the injection service URL Information ,URL There is a matching conflict in the information ');
}
});
}
}
}
if (null === result) {
throw Error(' No corresponding analog return data was found , Please check url、method Whether it is right , Whether the simulation injection service works or not ');
}
return testingObservable(result);
}

registerMockApi

/**
* Register the analog interface * @param url Request address
* @param method Request method
* @param callback Callback
*/
registerMockApi<T>(method: RequestMethodType, url: string, callback: RequestCallback<T>): void {
if (undefined === this.routers[method] || null === this.routers[method]) {
this.routers[method] = {} as Record<string, RequestCallback<T>>;
}
if (isNotNullOrUndefined(this.routers[method][url])) {
throw Error(` At the address ${url} Already exists ${method} Route records for `);
}
this.routers[method][url] = callback;
}

AnswerSheetApi

registerGetByPaperId()

private baseUrl = '/answerSheet';
/**
* register GetByPaperId Interface
* After registration , When other services try httpClient when
* The registration method will be used at this time 、URL Address matching
* After the match is successful, the callback function declared here will be called , The address will also be requested 、 Request parameters 、 request header The message is coming
* We finally return specific analog data based on the received parameters , The data is strictly consistent with the real interface in the background */
registerGetByPaperId(): void {
this.mockHttpService.registerMockApi<AnswerSheet>(
`get`,
`^${this.baseUrl}/(d+)$`,
(urlMatches, httpParams, httpHeaders, callback) => {
const id = urlMatches[1];
callback({
id: +id
});
}
);
}

injectMockHttpService

/**
* MOCK service .
*/mockHttpService: MockApiService;
/**
* Inject MOCK service
** @param mockHttpService simulation HTTP service
*/
injectMockHttpService(mockHttpService: MockApiService): void {
this.mockHttpService = mockHttpService;
this.registerGetByPaperId();
}

MockApiService

constructor()

/**
* Register the analog interface
* @param clazz Interface type
*/
static registerMockApi(clazz: Type<Api>): void {
this.mockApiRegisters.push(clazz);
}
/**
* Loop call to complete all interface registration */
constructor() {
MockApiService.mockApiRegisters.forEach(api => {
const instance = new api();
instance.injectMockHttpService(this);
});
}

// AnswerSheetApi
MockApiService.registerMockApi(AnswerSheetApi);

testingObservable

/**
* Return to the observer for testing
* If it is currently in the process of testing , Call cold Method returns the observer without throwing an exception .
* Otherwise use of Method back to the observer
* @param data Returned data
* @param delayCount Delay return interval
*/
export function testingObservable<T>(data: T, delayCount = 1): Observable<T> {
try {
let interval = '';
for (let i = 0; i < delayCount; i++) {
interval += '---';
}
return cold(interval + '(x|)', {x: data});
} catch (e) {
if (e.message === 'No test scheduler initialized') {
return of(data).pipe(delay(delayCount * 500));
} else {
throw e;
}
}
}

MockApiModule


/**
* Simulation background interface module
* because MockHttpClient Depend on MockApiService
* So it must be stated first that MockApiService, And then state MockHttpClient
* Otherwise, a dependency exception will be generated
* Every time you add a background analog interface , You need to add the providers.
* Otherwise, the analog interface will be angular Shake the tree optimization shake off , So that its registration method fails
*/
@NgModule({
providers: [
MockApiService,
{provide: HttpClient, useClass: MockHttpClient},
AnswerSheetApi
]
})
export class MockApiModule {
}

summary

image.png

版权声明
本文为[Jincheng]所创,转载请带上原文链接,感谢

  1. [front end -- JavaScript] knowledge point (IV) -- memory leakage in the project (I)
  2. This mechanism in JS
  3. Vue 3.0 source code learning 1 --- rendering process of components
  4. Learning the realization of canvas and simple drawing
  5. gin里获取http请求过来的参数
  6. vue3的新特性
  7. Get the parameters from HTTP request in gin
  8. New features of vue3
  9. vue-cli 引入腾讯地图(最新 api,rocketmq原理面试
  10. Vue 学习笔记(3,免费Java高级工程师学习资源
  11. Vue 学习笔记(2,Java编程视频教程
  12. Vue cli introduces Tencent maps (the latest API, rocketmq)
  13. Vue learning notes (3, free Java senior engineer learning resources)
  14. Vue learning notes (2, Java programming video tutorial)
  15. 【Vue】—props属性
  16. 【Vue】—创建组件
  17. [Vue] - props attribute
  18. [Vue] - create component
  19. 浅谈vue响应式原理及发布订阅模式和观察者模式
  20. On Vue responsive principle, publish subscribe mode and observer mode
  21. 浅谈vue响应式原理及发布订阅模式和观察者模式
  22. On Vue responsive principle, publish subscribe mode and observer mode
  23. Xiaobai can understand it. It only takes 4 steps to solve the problem of Vue keep alive cache component
  24. Publish, subscribe and observer of design patterns
  25. Summary of common content added in ES6 + (II)
  26. No.8 Vue element admin learning (III) vuex learning and login method analysis
  27. Write a mini webpack project construction tool
  28. Shopping cart (front-end static page preparation)
  29. Introduction to the fluent platform
  30. Webpack5 cache
  31. The difference between drop-down box select option and datalist
  32. CSS review (III)
  33. Node.js学习笔记【七】
  34. Node.js learning notes [VII]
  35. Vue Router根据后台数据加载不同的组件(思考-&gt;实现-&gt;不止于实现)
  36. Vue router loads different components according to background data (thinking - & gt; Implementation - & gt; (more than implementation)
  37. 【JQuery框架,Java编程教程视频下载
  38. [jQuery framework, Java programming tutorial video download
  39. Vue Router根据后台数据加载不同的组件(思考-&gt;实现-&gt;不止于实现)
  40. Vue router loads different components according to background data (thinking - & gt; Implementation - & gt; (more than implementation)
  41. 【Vue,阿里P8大佬亲自教你
  42. 【Vue基础知识总结 5,字节跳动算法工程师面试经验
  43. [Vue, Ali P8 teaches you personally
  44. [Vue basic knowledge summary 5. Interview experience of byte beating Algorithm Engineer
  45. 【问题记录】- 谷歌浏览器 Html生成PDF
  46. [problem record] - PDF generated by Google browser HTML
  47. 【问题记录】- 谷歌浏览器 Html生成PDF
  48. [problem record] - PDF generated by Google browser HTML
  49. 【JavaScript】查漏补缺 —数组中reduce()方法
  50. [JavaScript] leak checking and defect filling - reduce() method in array
  51. 【重识 HTML (3),350道Java面试真题分享
  52. 【重识 HTML (2),Java并发编程必会的多线程你竟然还不会
  53. 【重识 HTML (1),二本Java小菜鸟4面字节跳动被秒成渣渣
  54. [re recognize HTML (3) and share 350 real Java interview questions
  55. [re recognize HTML (2). Multithreading is a must for Java Concurrent Programming. How dare you not
  56. [re recognize HTML (1), two Java rookies' 4-sided bytes beat and become slag in seconds
  57. 【重识 HTML ,nginx面试题阿里
  58. 【重识 HTML (4),ELK原来这么简单
  59. [re recognize HTML, nginx interview questions]
  60. [re recognize HTML (4). Elk is so simple