275 lines
14 KiB
TypeScript
275 lines
14 KiB
TypeScript
// just for develop
|
||
|
||
export default {
|
||
config,
|
||
start,
|
||
stop,
|
||
register,
|
||
load,
|
||
task,
|
||
newCaller,
|
||
dataSet,
|
||
dataGet,
|
||
dataKeys,
|
||
dataCount,
|
||
dataFetch,
|
||
dataRemove,
|
||
listPush,
|
||
listPop,
|
||
listCount,
|
||
listRemove,
|
||
}
|
||
|
||
function config(config?: Config): void { }
|
||
function start(): string { return '' }
|
||
function stop(): void { }
|
||
function register(option: RegisterOption, callback: (params: RequestParams) => void): any { return null }
|
||
function load(serviceFile: string, poolConfig?: PoolConfig): void { }
|
||
|
||
function task(taskFile: string, interval: number = 1000): void { }
|
||
|
||
function newCaller(): Caller { return null as any }
|
||
|
||
function dataSet(scope: string, key: string, value: any): void { }
|
||
function dataGet(scope: string, key: string): any { return null }
|
||
function dataKeys(scope: string): string[] { return [] }
|
||
function dataCount(scope: string): number { return 0 }
|
||
function dataFetch(scope: string): Map<string, any> { return null as any }
|
||
function dataRemove(scope: string, key?: string): void { }
|
||
|
||
function listPush(scope: string, key: string, value: any): void { }
|
||
function listPop(scope: string, key: string): any { return null }
|
||
function listCount(scope: string): number { return 0 }
|
||
function listRemove(scope: string): void { }
|
||
|
||
|
||
interface Config {
|
||
// github.com/ssgo/s 的配置参数
|
||
listen: string // 监听端口（|隔开多个监听）（,隔开多个选项）（如果不指定IP则监听在0.0.0.0，如果不指定端口则使用h2c协议监听在随机端口，80端口默认使用http协议，443端口默认使用https协议），例如 80,http|443|443:h2|127.0.0.1:8080,h2c
|
||
ssl: Map<string, CertSet> // SSL证书配置，key为域名，value为cert和key的文件路径
|
||
noLogGets: boolean // 不记录GET请求的日志
|
||
noLogHeaders: string // 不记录请求头中包含的这些字段，多个字段用逗号分隔，默认不记录：Accept,Accept-Encoding,Cache-Control,Pragma,Connection,Upgrade-Insecure-Requests
|
||
logInputArrayNum: number // 请求字段中容器类型（数组、Map）在日志打印个数限制 默认为10个，多余的数据将不再日志中记录
|
||
logInputFieldSize: number // 请求字段中单个字段在日志打印长度限制 默认为500个字符，多余的数据将不再日志中记录
|
||
noLogOutputFields: string // 不记录响应字段中包含的这些字段（key名），多个字段用逗号分隔
|
||
logOutputArrayNum: number // 响应字段中容器类型（数组、Map）在日志打印个数限制 默认为3个，多余的数据将不再日志中记录
|
||
logOutputFieldSize: number // 响应字段中单个字段在日志打印长度限制 默认为100个字符，多余的数据将不再日志中记录
|
||
logWebsocketAction: boolean // 记录Websocket中每个Action的请求日志，默认不记录
|
||
compress: boolean // 是否启用压缩，默认不启用
|
||
compressMinSize: number // 小于设定值的应答内容将不进行压缩，默认值：1024
|
||
compressMaxSize: number // 大于设定值的应答内容将不进行压缩，默认值：4096000
|
||
checkDomain: string // 心跳检测时使用域名，，默认使用IP地址，心跳检测使用 HEAD /__CHECK__ 请求，应答 299 表示正常，593 表示异常
|
||
redirectTimeout: number // proxy和discover发起请求时的超时时间，单位ms，默认值：10000
|
||
acceptXRealIpWithoutRequestId: boolean // 是否允许头部没有携带请求ID的X-Real-IP信息，默认不允许（防止伪造客户端IP）
|
||
statisticTime: boolean // 是否开启请求时间统计，默认不开启
|
||
statisticTimeInterval: number // 统计时间间隔，单位ms，默认值：10000
|
||
fast: boolean // 是否启用快速模式（为了追求性能牺牲一部分特性），默认不启用
|
||
maxUploadSize: number // 最大上传文件大小（multipart/form-data请求的总空间），单位字节，默认值：104857600
|
||
cpu: number // CPU占用的核数，默认为0，即不做限制
|
||
memory: number // 内存（单位M），默认为0，即不做限制
|
||
cpuMonitor: boolean // 在日志中记录CPU使用情况，默认不开启
|
||
memoryMonitor: boolean // 在日志中记录内存使用情况，默认不开启
|
||
cpuLimitValue: number // CPU超过最高占用值（10-100）超过次数将自动重启（如果CpuMonitor开启的话），默认100
|
||
memoryLimitValue: number // 内存超过最高占用值（10-100）超过次数将自动重启（如果MemoryMonitor开启的话），默认95
|
||
cpuLimitTimes: number // CPU超过最高占用值超过次数（1-100）将报警（如果CpuMonitor开启的话），默认6（即30秒内连续6次）
|
||
memoryLimitTimes: number // 内存超过最高占用值超过次数（1-100）将报警（如果MemoryMonitor开启的话），默认6（即30秒内连续6次）
|
||
cookieScope: string // 启用Session时Cookie的有效范围，host|domain|topDomain，默认值为host
|
||
idServer: string // 用s.UniqueId、s.Id来生成唯一ID（雪花算法）时所需的redis服务器连接，如果不指定将不能实现跨服务的全局唯一
|
||
keepKeyCase: boolean // 是否保持Key的首字母大小写？默认一律使用小写
|
||
indexFiles: string[] // 访问静态文件时的索引文件，默认为 index.html
|
||
indexDir: boolean // 访问目录时显示文件列表
|
||
readTimeout: number // 读取请求的超时时间，单位ms
|
||
readHeaderTimeout: number // 读取请求头的超时时间，单位ms
|
||
writeTimeout: number // 响应写入的超时时间，单位ms
|
||
idleTimeout: number // 连接空闲超时时间，单位ms
|
||
maxHeaderBytes: number // 请求头的最大字节数
|
||
maxHandlers: number // 每个连接的最大处理程序数量
|
||
maxConcurrentStreams: number // 每个连接的最大并发流数量
|
||
maxDecoderHeaderTableSize: number // 解码器头表的最大大小
|
||
maxEncoderHeaderTableSize: number // 编码器头表的最大大小
|
||
maxReadFrameSize: number // 单个帧的最大读取大小
|
||
maxUploadBufferPerConnection: number // 每个连接的最大上传缓冲区大小
|
||
maxUploadBufferPerStream: number // 每个流的最大上传缓冲区大小
|
||
|
||
// 其他配置
|
||
sessionKey: string // HTTP头和Cookie中SessionID的Key，客户端没有传递时服务端自动生成，Header的优先级高于Cookie，默认为 Session, 设置为空时表示不使用
|
||
deviceKey: string // 标识设备ID的Key，客户端没有传递时服务端自动生成，Header的优先级高于Cookie，默认为 Device， 设置为空时表示不使用
|
||
clientKey: string // 标识客户端的Key，默认为 Client，对应的Header头为 ClientName 和 ClientVersion
|
||
userIdKey: string // session中userID的Key，用于在日志中记录userId信息，默认为 userId
|
||
sessionProvider: string // 指定一个redis连接（例如：redis://:sskey加密的密码@127.0.0.1:6379/15），默认使用内存存储
|
||
sessionTimeout: number // session过期时间，单位 秒，默认为 3600秒
|
||
authFieldMessage: string | Object // 身份验证失败时的消息，默认为 auth failed，可以设置对象来返回JSON，可以使用模版 {{TARGET_AUTHLEVEL}}、{{USER_AUTHLEVEL}}
|
||
verifyFieldMessage: string | Object // 参数验证失败时的消息，默认为 verify failed，可以设置对象来返回JSON，可以使用模版 {{FAILED_FIELDS}}
|
||
limitedMessage: string | Object // 访问受限时的消息，默认为 too many requests，可以设置对象来返回JSON，可以使用模版 {{LIMITED_FROM}}、{{LIMITED_VALUE}}
|
||
limiterRedis: string // 限流器使用的Redis连接，默认使用内存存储
|
||
limiters: Map<string, LimiterConfig> // 限流器配置，from 为数据来源，例如：ip、user、device、header.User-Agent、in.phone 等（in表示从请求参数中获取），time为时间间隔，单位ms，times为 时间间隔内允许访问的次数
|
||
|
||
// gateway 的配置参数
|
||
proxy: Map<string, string> // 代理配置，key为[host][path]，value为代理的目标应用或URL
|
||
rewrite: Map<string, string> // 重写请求路径，key为[host][path]，value为重写后的路径
|
||
static: Map<string, string> // 静态文件目录，key为[host][path]，value为目录路径
|
||
|
||
// github.com/ssgo/discover 的配置参数
|
||
registry: string // 服务注册中心，请配置一个有效的RedisURL，默认值 redis://:@127.0.0.1:6379/15
|
||
app: string // 设置该值将会自动将服务注册到 discover
|
||
weight: number // 节点的权重，默认值 100
|
||
accessTokens: Map<string, number> // 请求接口时使用指定的Access-Token进行验证，值为Token对应的authLevel（允许访问大于等于指定对应authLevel的接口）
|
||
calls: Map<string, string> // 配置将会调用的服务，格式：[1|2]:[http|https|h2c]:[AccessToken]，默认协议为：h2c，如使用h2c协议可只提供 AccessToken
|
||
callRetryTimes: number // 调用其他服务时最大重试次数，默认值 10
|
||
ipPrefix: string // discover服务发现时指定使用的IP网段，默认排除 172.17.（Docker）
|
||
}
|
||
|
||
interface CertSet {
|
||
certFile: string
|
||
keyFile: string
|
||
}
|
||
|
||
interface PoolConfig {
|
||
min: number
|
||
max: string
|
||
idle: number
|
||
}
|
||
|
||
interface LimiterConfig {
|
||
from: string
|
||
time: number
|
||
times: number
|
||
}
|
||
|
||
interface RegisterOption {
|
||
authLevel: number
|
||
host: string
|
||
method: string
|
||
path: string
|
||
memo: string
|
||
noBody: boolean
|
||
noLog200: boolean
|
||
limiters: string[]
|
||
onMessage: (params: OnMessageParams) => void
|
||
onClose: (params: RequestParams) => void
|
||
}
|
||
|
||
interface RequestParams {
|
||
args: Object
|
||
headers: Object
|
||
request: Request
|
||
client: WSClient
|
||
caller: Caller
|
||
session: Session
|
||
response: Response
|
||
logger: Logger
|
||
}
|
||
|
||
interface OnMessageParams {
|
||
type: string
|
||
data: string | Object
|
||
client: WSClient
|
||
session: Session
|
||
logger: Logger
|
||
}
|
||
|
||
interface WSClient {
|
||
id: string
|
||
read: () => WSMessage
|
||
write: (data: any) => void
|
||
writeMessage: (type: string, data: any) => void
|
||
ping: () => void
|
||
close: () => void
|
||
}
|
||
|
||
interface WSMessage {
|
||
type: string
|
||
data: string | Object
|
||
}
|
||
|
||
interface Session {
|
||
set: (key: string | Object, value?: any) => void
|
||
get: (...keys: string[]) => any | Object
|
||
remove: (...keys: string[]) => void
|
||
setAuthLevel: (authLevel: number) => void
|
||
save: () => void
|
||
}
|
||
|
||
interface Caller {
|
||
get(url: string, headers?: Object): Result
|
||
head(url: string, headers?: Object): Result
|
||
post(url: string, data: any, headers?: Object): Result
|
||
put(url: string, data: any, headers?: Object): Result
|
||
delete(url: string, data: any, headers?: Object): Result
|
||
do(method: string, url: string, data: any, callback?: (data: string) => void, headers?: Object): Result
|
||
}
|
||
|
||
interface Result {
|
||
status: string
|
||
statusCode: number
|
||
headers: Object
|
||
bytes(): Uint8Array
|
||
string(): string
|
||
object(): Object
|
||
}
|
||
|
||
interface CookieOption {
|
||
path: string
|
||
domain: string
|
||
expires: any
|
||
maxAge: number
|
||
secure: boolean
|
||
httpOnly: boolean
|
||
}
|
||
|
||
interface Request {
|
||
id: string
|
||
proto: string
|
||
scheme: string
|
||
host: string
|
||
method: string
|
||
path: string
|
||
remoteAddr: string
|
||
realIP: string
|
||
referer: string
|
||
userAgent: string
|
||
url: string
|
||
contentLength: number
|
||
cookies: Object
|
||
headers: Object
|
||
args: Object
|
||
files: Map<string, UploadFile>
|
||
multiFiles: Map<string, UploadFile[]>
|
||
makeURL: (path: string) => string
|
||
readAll: () => any
|
||
read: (size: number) => any
|
||
close: () => void
|
||
get: (key: string) => any
|
||
set: (key: string, value: any) => void
|
||
getHeader: (key: string) => string
|
||
setHeader: (key: string, value: string) => void
|
||
setUserID: (id: string) => void
|
||
}
|
||
|
||
interface Response {
|
||
id: string
|
||
setStatus: (code: number) => void
|
||
setCookie: (name: string, value: string, option?: CookieOption) => void
|
||
setHeader: (name: string, value: string) => void
|
||
addHeader: (name: string, value: string) => void
|
||
getHeader: (name: string) => string
|
||
write: (data: any) => number
|
||
flush: () => void
|
||
sendFile: (contentType: string, filename: string) => void
|
||
downloadFile: (contentType: string, filename: string, data: any) => void
|
||
location: (url: string) => void
|
||
}
|
||
|
||
interface Logger {
|
||
debug: (message: string, info?: Object) => void
|
||
info: (message: string, info?: Object) => void
|
||
warn: (message: string, info?: Object) => void
|
||
error: (message: string, info?: Object) => void
|
||
}
|
||
|
||
interface UploadFile {
|
||
name: string
|
||
size: number
|
||
data: any
|
||
}
|