# web.rpc.jsonServer 库模块帮助文档

## web.rpc 成员列表 <a id="web.rpc" href="#web.rpc">&#x23;</a>

### web.rpc.jsonServer <a id="web.rpc.jsonServer" href="#web.rpc.jsonServer">&#x23;</a>
基于HTTP协议的JSON-RPC 2.0服务端  
需要在HTTP服务器上运行  
[关于JSON-RPC 2.0](http://www.jsonrpc.org/specification)

### web.rpc.jsonServer() <a id="web.rpc.jsonServer" href="#web.rpc.jsonServer">&#x23;</a>
创建JSON-RPC 2.0服务端  
可选在构造参数中指定监听客户端调用的监听器对象  
如果不指定参数,保用对象自身监听客户端调用  

[返回对象:webrpcjsonServerObject](#webrpcjsonServerObject)

## webrpcjsonServerObject 成员列表 <a id="webrpcjsonServerObject" href="#webrpcjsonServerObject">&#x23;</a>

### webrpcjsonServerObject.* <a id="webrpcjsonServerObject.any" href="#webrpcjsonServerObject.any">&#x23;</a>
客户端可以调用的远程对象名或远程方法名字,  
客户端传过来的params参数必须是数组  
服务端会展开此数组作为函数的调用参数  
函数第一个返回值指定为客户端获取的result返回值  
函数的第二个返回值指定为客户端error错误对象  
错误对象可以是数值，字符串、或符合JSON-RPC2.0协议的表对象,  

[返回对象:webRpcJsonClientObject](https://www.aardio.com/zh-cn/docs/library-reference/web/rpc/jsonClient.html#webRpcJsonClientObject)

## webrpcjsonServerObject.rpc 成员列表 <a id="webrpcjsonServerObject.rpc" href="#webrpcjsonServerObject.rpc">&#x23;</a>

### webrpcjsonServerObject.rpc.aasdl <a id="webrpcjsonServerObject.rpc.aasdl" href="#webrpcjsonServerObject.rpc.aasdl">&#x23;</a>
指定自定义的aasdl  
如果不指定,服务端会根据external自动生成aasdl  
如果客户端请求的方法名为"?"时,返回此属性,  
[关于aasdl](https://github.com/aardio/aardio-js/blob/master/AASDL.md)

### webrpcjsonServerObject.rpc.afterJsonStringify <a id="webrpcjsonServerObject.rpc.afterJsonStringify" href="#webrpcjsonServerObject.rpc.afterJsonStringify">&#x23;</a>

```aardio
webrpcjsonServerObject.rpc.afterJsonStringify = function(jsonData){
    /*可以在这里加密服务端JSON,返回null中止本次调用*/
	return jsonData;
}
```

### webrpcjsonServerObject.rpc.beforeJsonParse <a id="webrpcjsonServerObject.rpc.beforeJsonParse" href="#webrpcjsonServerObject.rpc.beforeJsonParse">&#x23;</a>

```aardio
webrpcjsonServerObject.rpc.beforeJsonParse = function(jsonData){
    /*可以在这里解密客户端数据,返回null中止本次调用*/
	return jsonData;
}
```

### webrpcjsonServerObject.rpc.external <a id="webrpcjsonServerObject.rpc.external" href="#webrpcjsonServerObject.rpc.external">&#x23;</a>
指定包含客户端可以调用的远程函数的表对象,可嵌套子表  

如果远程函数名第一个字符是$,则第一个回调参数为$,$对象由run函数指定,  
如果创建服务端对象的构造参数中没有指定表,  
这个对象默认指向对象自身  
可在调用run函数之前更改此对象

### webrpcjsonServerObject.rpc.run() <a id="webrpcjsonServerObject.rpc.run" href="#webrpcjsonServerObject.rpc.run">&#x23;</a>
运行JSON-RPC服务端响应用户请求  
可选在函数参数中所有名字首字符为$的回调函数的首个回调$参数,  
$参数默认为request

## webrpcjsonServerObject.rpc 事件列表 <a id="webrpcjsonServerObject.rpcEvent" href="#webrpcjsonServerObject.rpcEvent">&#x23;</a>

### webrpcjsonServerObject.rpc.onError <a id="webrpcjsonServerObject.rpc.onError" href="#webrpcjsonServerObject.rpc.onError">&#x23;</a>

```aardio
webrpcjsonServerObject.rpc.onError = function(err,requestData){
	/*服务器内部错误时触发此事件  
err为抛出的异常对象,一般为错误信息  
requestData为客户端发送的请求数据*/
}
```

### 自动完成常量
_JSONRPC_INTERNAL_ERROR=-32603  
_JSONRPC_INVALID_PARAMS=-32602  
_JSONRPC_INVALID_REQUEST=-32600  
_JSONRPC_METHOD_NOTFOUND=-32601  
_JSONRPC_PARSE_ERROR=-32700  
