Web组件中onLoadIntercept、onInterceptRequest、WebSchemeHandler、onOverrideUrlLoading都是用于请求的拦截,这几个接口的作用分别是什么,适用于哪些场景?
接口使用场景汇总说明:
场景 | ||||
|---|---|---|---|---|
拦截时机 | Web组件加载url之前触发(在请求发起前) | Web组件加载url之前触发(仅在onLoadIntercept返回false后执行) | 当请求匹配注册的Scheme时触发 | url将要加载到当前Web组件时触发(针对用户交互行为) |
拦截范围 | 页面主url请求(包括页面及iframe导航行为),不包括子资源(如js/css/图片) | 页面主url请求和所有子资源请求(包括HTTP/HTTPS请求) | 仅限于注册了特定Scheme的请求,不匹配Scheme的请求由Web组件默认处理 |
|
适用场景 |
|
|
|
|
性能影响 | 低(仅页面加载时触发一次,对性能影响小) | 中到高(所有请求均触发回调,逻辑复杂时可能影响性能) | 低到中(仅处理注册Scheme请求,性能开销小) | 低到中(仅在用户交互时触发,性能影响一般) |
关键特性 |
|
|
|
|
接口常用使用场景:
Q:使用onLoadIntercept如何实现重定向?
A:请参考文档:请求重定向。
Q:如何实现页面白名单,只允许加载白名单内的网页?
A:可通过onLoadIntercept拦截所有页面请求,判断是否在白名单清单内,在白名单内则放行,不在白名单内需用户同意才可访问,具体实现请参考文档:页面白名单配置。
Q:onInterceptRequest处理本地资源跨域与WebSchemeHandler处理远程请求跨域有什么区别?
A:跨域指浏览器从一个域名的网页去请求另一个域名的资源时,域名、端口、协议任一不同时为跨域。
Q:使用WebSchemeHandler拦截POST请求时,如何获取POST请求体?
A:可参考如下代码:
import { WebNetErrorList, webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';
import { buffer, util } from '@kit.ArkTS';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController();
schemeHandler: webview.WebSchemeHandler = new webview.WebSchemeHandler();
htmlData: string = '<html><body bgcolor="white">Source:<pre>source</pre></body></html>';
build() {
Column() {
Web({
// 使用时请替换为真实url
src: 'https://*****',
controller: this.controller
})
.onControllerAttached(() => {
try {
this.schemeHandler.onRequestStart((request: webview.WebSchemeHandlerRequest,
resourceHandler: webview.WebResourceHandler) => {
console.info('[schemeHandler] onRequestStart');
try {
// 可以指定请求不做拦截
if (request.getRequestMethod() !== 'POST') {
return false;
}
// 获取POST请求体
let stream = request.getHttpBodyStream();
if (stream) {
stream.initialize().then(() => {
if (!stream) {
console.error('[schemeHandler] HttpBodyStream initialize failed.');
return;
}
let size = stream.getSize();
console.info(`[schemeHandler] HttpBodyStream size is ${size}`);
stream.read(size).then((result: ArrayBuffer) => {
console.info(`[schemeHandler] HttpBodyStream buffer length is ${result.byteLength}`);
// 从buffer中转换请求体内容
let decoder = util.TextDecoder.create('utf-8');
let requestBodyStr = decoder.decodeToString(new Uint8Array(result));
console.info(`[schemeHandler] HttpBodyStream requestBody is ${requestBodyStr}`);
}).catch((error: BusinessError) => {
console.error(`[schemeHandler] HttpBodyStream read failed, message is ${error.message}`);
});
});
} else {
console.info('[schemeHandler] onRequestStart has no http body stream');
}
} catch (error) {
console.error(`[schemeHandler] ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
// 构造响应体返回
let response = new webview.WebSchemeHandlerResponse();
try {
response.setNetErrorCode(WebNetErrorList.NET_OK);
response.setStatus(200);
response.setStatusText('OK');
response.setMimeType('text/html');
response.setEncoding('utf-8');
response.setHeaderByName('header1', 'value1', false);
} catch (error) {
console.error(`[schemeHandler] ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
// 调用didFinish/didFail前需要优先调用didReceiveResponse将构造的响应头传递给被拦截的请求。
let buf = buffer.from(this.htmlData);
try {
if (buf.length == 0) {
console.info('[schemeHandler] length 0');
resourceHandler.didReceiveResponse(response);
// 如果认为buf.length为0是正常情况,则调用resourceHandler.didFinish,否则调用resourceHandler.didFail
resourceHandler.didFail(WebNetErrorList.ERR_FAILED);
} else {
console.info('[schemeHandler] length 1');
resourceHandler.didReceiveResponse(response);
resourceHandler.didReceiveResponseBody(buf.buffer);
resourceHandler.didFinish();
}
} catch (error) {
console.error(`[schemeHandler] ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
return true;
});
this.schemeHandler.onRequestStop((request: webview.WebSchemeHandlerRequest) => {
console.info('[schemeHandler] onRequestStop, url:' + request.getRequestUrl());
});
this.controller.setWebSchemeHandler('https', this.schemeHandler);
} catch (error) {
console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
})
.javaScriptAccess(true)
.domStorageAccess(true)
.fileAccess(true)
.geolocationAccess(false);
};
}
} Q:H5通过Web组件加载,想要拦截所有网络请求,对请求进行加解密、或者代理请求,替换header等,如何实现?
A:可通过WebSchemeHandler定义schema,拦截网页所有请求后,获取请求体,请求header等,可进行加密,修改请求体、url等操作,修改完成后,通过rcp重新发送请求,获取rcp响应之后,再获取rcp响应报文,对响应报文进行解密、修改响应体等操作,修改完成之后,再返回给Web请求的响应。
参考如下代码:
import { WebNetErrorList, webview } from '@kit.ArkWeb';
import { rcp } from '@kit.RemoteCommunicationKit';
import { BusinessError } from '@kit.BasicServicesKit';
// 源url
const SOURCE_URL: string = 'https://***1';
// 目标url
const TARGET_URL: string = 'https://***2';
export class HttpProxy {
session = rcp.createSession();
constructor(sessionConfiguration?: rcp.SessionConfiguration | undefined) {
try {
this.session = rcp.createSession(sessionConfiguration);
} catch (error) {
console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
}
/**
* 处理响应
* @param res
* @param resourceHandler
*/
private handleResponse(res: rcp.Response, resourceHandler: webview.WebResourceHandler): void {
let response = new webview.WebSchemeHandlerResponse();
response.setStatus(res.statusCode);
response.setStatusText('OK');
response.setNetErrorCode(WebNetErrorList.NET_OK);
// 将rcp响应头塞到Web响应头中,此处响应头也可自定义
Object.keys(res.headers).forEach((key: string) => {
const value = res.headers[key];
if (value) {
console.log(`请求头:${key}:${value}`);
response.setHeaderByName(key, value?.toString(), true);
}
});
// 不涉及跨域,可手动删除下面的header
response.setHeaderByName('Access-Control-Allow-Origin', '*', true);
response.setHeaderByName('Access-Control-Allow-Credentials', 'true', true);
response.setHeaderByName('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE', true);
response.setHeaderByName('Access-Control-Allow-Headers', 'Content-Type, Authorization', true);
try {
// 将响应返回给Web
resourceHandler.didReceiveResponse(response);
resourceHandler.didReceiveResponseBody(res.body);
resourceHandler.didFinish();
} catch (error) {
console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
}
/**
* 代理请求
* @param request
* @param resourceHandler
*/
public fetch(request: webview.WebSchemeHandlerRequest, resourceHandler: webview.WebResourceHandler): void {
try {
// 替换请求url
let url = request.getRequestUrl().replace(SOURCE_URL, TARGET_URL);
// 此处rcp请求,可自定义增加header、cookie、请求参数、对请求体加解密等
let req = new rcp.Request(url, request.getRequestMethod());
this.session?.fetch(req).then((res) => {
this.handleResponse(res, resourceHandler);
}).catch((error: BusinessError) => {
console.error(`ErrorCode: ${error.code}, Message: ${error.message}`);
});
} catch (error) {
console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
}
}
@Entry
@Component
struct WebRequestProxyDemo {
controller: webview.WebviewController = new webview.WebviewController();
schemeHandler: webview.WebSchemeHandler = new webview.WebSchemeHandler();
httpProxy: HttpProxy = new HttpProxy();
uiContext: UIContext = this.getUIContext();
aboutToAppear(): void {
webview.WebviewController.setWebDebuggingAccess(true);
}
build() {
Column() {
Web({ src: SOURCE_URL, controller: this.controller })
.onControllerAttached(() => {
try {
this.schemeHandler.onRequestStart((request: webview.WebSchemeHandlerRequest,
resourceHandler: webview.WebResourceHandler) => {
console.info('[schemeHandler] onRequestStart');
// 对请求进行拦截,拦截规则可自定义
if (request.getRequestUrl().includes(SOURCE_URL)) {
// 使用rcp代理请求
this.httpProxy.fetch(request, resourceHandler);
return true;
} else {
return false;
}
});
// 通过WebSchemeHandler,拦截所有https协议请求
this.controller.setWebSchemeHandler('https', this.schemeHandler);
} catch (error) {
console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`);
}
})
.fileAccess(true)
.geolocationAccess(false);
}
.width('100%')
.height('100%');
}
}