用户指南 | 优宽量化

策略入口函数

对于JavaScript、Python、Rust、C++语言的策略，优宽量化交易平台已预先定义了以下入口函数。

函数名	说明
`main()`	入口函数，即策略的主函数。
`onexit()`	正常退出时的扫尾函数，最长执行时间为5分钟，可以不声明；若执行超时，将报interrupt错误。在实盘中，若已先触发`onerror()`函数，则不会再触发`onexit()`函数。
`onerror()`	异常退出时触发执行的函数，最长执行时间为5分钟，可以不声明。使用`Python`语言、`C++`语言编写的策略不支持该函数，回测系统亦不支持该函数。
`init()`	初始化函数，策略程序在开始运行时会首先自动调用该函数，可以不声明。

注意事项：

当main()函数执行结束时，所有已创建的子线程都会被自动终止。
在Rust语言策略中，直接定义fn main()、fn init()、fn onexit()即可（由引导层自动调用）；也可以在策略代码中调用OnExit()注册额外的退出钩子，详见「Rust策略编写说明」。

onexit()

onexit()函数由用户实现，用于处理程序退出前的扫尾工作，最长执行时间为 5 分钟。

示例

测试onexit()函数：


    javascript
    
    
function main(){
    Log("开始运行, 5秒后停止，并执行扫尾函数！")
    Sleep(1000 * 5)
}

// 扫尾函数实现
function onexit(){
    // 不使用接口获取数据的测试，就无需使用exchange.IO("status")函数判断连接状态，也不用设置合约代码，因为这里仅仅是测试
    var beginTime = new Date().getTime()
    while(true){
        var nowTime = new Date().getTime()
        Log("程序停止倒计时..扫尾开始，已经过去：", (nowTime - beginTime) / 1000, "秒！")
        Sleep(1000)
    }
}


    python
    
    
import time
def main():
    Log("开始运行, 5秒后停止，并执行扫尾函数！")
    Sleep(1000 * 5)

def onexit():
    beginTime = time.time() * 1000
    while True:
        ts = time.time() * 1000
        Log("程序停止倒计时..扫尾开始，已经过去：", (ts - beginTime) / 1000, "秒！")
        Sleep(1000)


    rust
    
    
fn main() {
    Log!("开始运行, 5秒后停止，并执行扫尾函数！");
    Sleep(1000 * 5);
}

// 扫尾函数实现
fn onexit() {
    // 不使用接口获取数据的测试，就无需使用exchange.IO("status")函数判断连接状态，也不用设置合约代码，因为这里仅仅是测试
    let beginTime = Unix() * 1000;
    loop {
        let nowTime = Unix() * 1000;
        Log!("程序停止倒计时..扫尾开始，已经过去：", (nowTime - beginTime) / 1000, "秒！");
        Sleep(1000);
    }
}


    c++
    
    
void main() {
    Log("开始运行, 5秒后停止，并执行扫尾函数！");
    Sleep(1000 * 5);
}

void onexit() {
    auto beginTime = Unix() * 1000;
    while(true) {
        auto ts = Unix() * 1000;
        Log("程序停止倒计时..扫尾开始，已经过去：", (ts - beginTime) / 1000, "秒！");
        Sleep(1000);
    }
}

在回测系统中，策略通常被设计为一个死循环持续轮询执行，这会导致策略中实现的onexit()函数无法被触发。此时可以通过检测回测系统的结束标记（EOF 异常）来触发onexit()函数的执行。


    javascript
    
    
function main() {
    exchange.SetContractType("rb888")

    if (IsVirtual()) {
        try {
            onTick()
        } catch (e) {
            Log("error:", e)
        }
    } else {
        onTick()
    }
}

function onTick() {
    while (true) {
        var ticker = exchange.GetTicker()
        LogStatus(_D(), ticker ? ticker.Last : "--")
        Sleep(500)
    }
}

function onexit() {
    Log("执行扫尾函数")
}


    python
    
    
def main():
    exchange.SetContractType("rb888")

    if IsVirtual():
        try:
            onTick()
        except Exception as e:
            Log(e)
    else:
        onTick()

def onTick():
    while True:
        ticker = exchange.GetTicker()
        LogStatus(_D(), ticker["Last"] if ticker else "--")
        Sleep(500)

def onexit():
    Log("执行扫尾函数")


    rust
    
    
fn onTick() {
    loop {
        match exchange.GetTicker(None) {
            Ok(ticker) => LogStatus!(_D(None), ticker.Last),
            Err(e) => {
                // 回测结束时接口调用返回 Err，无需像 JavaScript 那样用 try/catch 捕获回测结束异常
                Log!("error:", e);
                return;
            }
        }
        Sleep(500);
    }
}

fn main() {
    let _ = exchange.SetContractType("rb888");

    onTick();
}

fn onexit() {
    Log!("执行扫尾函数");
}


    c++
    
    
#include <iostream>
#include <exception>
#include <string>

void onTick() {
    while (true) {
        auto ticker = exchange.GetTicker();
        LogStatus(_D(), ticker);
        Sleep(500);
    }
}

void main() {
    exchange.SetContractType("rb888");

    if (IsVirtual()) {
        try {
            onTick();
        } catch (...) {
            std::cerr << "Caught unknown exception" << std::endl;
        }
    } else {
        onTick();
    }
}

void onexit() {
    Log("执行扫尾函数");
}

init()

init() 为用户自行实现的初始化函数。策略开始运行时会首先自动执行 init() 函数，以完成策略中设计的各项初始化任务。

示例


    javascript
    
    
function main(){
    // 不使用接口获取数据的测试，就无需使用exchange.IO("status")函数判断连接状态，也不用设置合约代码，因为这里仅仅是测试
    Log("程序第一行代码执行！", "#FF0000")
    Log("退出！")
}

// 初始化函数
function init(){
    Log("初始化！")
}


    python
    
    
def main():
    Log("程序第一行代码执行！", "#FF0000")
    Log("退出！")

def init():
    Log("初始化！")


    rust
    
    
fn main() {
    Log!("程序第一行代码执行！", "#FF0000");
    Log!("退出！");
}

// 初始化函数
fn init() {
    Log!("初始化！");
}


    c++
    
    
void main() {
    Log("程序第一行代码执行！", "#FF0000");
    Log("退出！");
}

void init() {
    Log("初始化！");
}

onerror()

onerror()，当发生异常时会触发onerror()函数执行。该函数不支持Python、C++语言的策略。

onerror()函数可以接收一个msg参数，该参数包含异常触发时的错误信息。

示例


    javascript
    
    
function main() {
    // 不使用接口获取数据的测试，就无需使用exchange.IO("status")函数判断连接状态，也不用设置合约代码，因为这里仅仅是测试
    var arr = []
    Log(arr[6].Close)  // 这里故意引发一个程序异常
}

function onerror(msg) {
    Log("错误：", msg)
}


    python
    
    
# python不支持


    c++
    
    
// C++不支持