中泰证券量化交易平台XTP JAVA API接口

本项目是中泰证券XTP极速交易JAVA接口的开源实现，供客户在量化交易中使用JAVA接口快速接入XTP系统。中泰证券XTP是为股票交易而生的极速交易系统，为投资者提供极速交易、极速行情、Level2行情。

目前支持xtp api版本为2.2.32.2，支持win64、linux平台运行，注意mac平台未进行编译测试，如需使用mac版本请自行编译调试

请先到中泰证券xtp官方网站申请测试账号 https://xtp.zts.com.cn/register 及测试环境的连接ip、端口等信息
                                                                                    
API参考官方C++版本的接口文档https://xtp.zts.com.cn/home

如果您的linux是centos6版本，请先手工将cpp/lib/linux_centos6下的两个so覆盖到cpp/lib/linux下，默认cpp/lib/linux下是同cpp/lib/linux_centos7一样的版本编译的

#Version history

v2.2.32.2-2.0.0     1.新增支持算法总线服务
                    2.新增支持融资融券业务
                    3.java api的下单接口insertOrder逻辑优化：java api的下单接口参数传递由原来的OrderInsertRequest对象，展开为具体的属性；通过jni传到c++，然后再组装成一个c++对象，最后再调用xtp api的下单接口
                    4.java api的委托回报接口onOrderEvent逻辑优化：onOrderEvent的入参OrderResponse对象和ErrorMessage对象展开为具体的对象属性，java端收到这些属性值之后，可以根据实际需要再组装成对象，也可以只取需要的部分数据。
                    5.java api的成交回报接口onTradeEvent逻辑优化：onTradeEvent的入参TradeResponse对象展开为具体的对象属性，java端收到这些属性值之后，可以根据实际需要再组装成对象，也可以只取需要的部分数据。
                    6.java api的行情快照回调接口onDepthMarketData逻辑优化：onDepthMarketData的入参DepthMarketDataResponse对象展开为具体的对象属性，去掉了部分扩展数据，减少带宽占用，java端收到这些属性值之后，可以根据实际需要再组装成对象，也可以只取需要的部分数据。
                    7.java api的行情丁单薄回调接口onOrderBook逻辑优化：onOrderBook的入参OrderBookResponse对象展开为具体的对象属性，java端收到这些属性值之后，可以根据实际需要再组装成对象，也可以只取需要的部分数据。
                    8.java api的逐笔行情（委托）回调接口onTickByTickEntrust逻辑优化：onTickByTickEntrust的入参TickByTickEntrustResponse对象展开为具体的对象属性，java端收到这些属性值之后，可以根据实际需要再组装成对象，也可以只取需要的部分数据。
                    9.java api的逐笔行情（成交）回调接口onTickByTickTrade逻辑优化：onTickByTickTrade的入参TickByTickTradeResponse对象展开为具体的对象属性，java端收到这些属性值之后，可以根据实际需要再组装成对象，也可以只取需要的部分数据。
                    10.user.config.properites配置文件新增配置项：threadNum（行情接收线程数）和ringBufferSize（行情数据接收缓冲区）
                    
                    

v1.1.19.2-1.1.4     1.解决资金划拨出现异常时XTPFundTransferNotice对象返回空值问题

v1.1.19.2-1.1.3     1.解决开平标志错误

v1.1.19.2-1.1.2     1.将java api中OrderResponse和OrderCancelResponse中的撤单id
                    2.orderCancelXtpId由int改为String；扩充EtfReplaceType的枚举类型
                    
v1.1.19.2-1.1.1     1.解决queryAllTicker响应异常问题

v1.1.19.2-1.1.0     1.支持xtp api 1.1.19.2、支持科创板业务：TickerType新增XTP_TICKER_TYPE_TECH_STOCK枚举、IPOTickerResponse新增tickerType属性、IPOQuotaResponse新增tech_quantity、uused属性
                    2.新增分页请求查询报单queryOrdersByPage、分页请求查询成交回报queryTradesByPage、判断服务器是否重启过isServerRestart三个api及对应spi实现

v1.1.18.19-1.0.5    v1.1.18.19版本已经不再维护，请使用上面最新版本
                    1.将java api中OrderResponse和OrderCancelResponse中的撤单id
                    2.orderCancelXtpId由int改为String；扩充EtfReplaceType的枚举类型
                    
v1.1.18.19-1.0.4    1.解决queryAllTicker响应异常问题  

v1.1.18.19-1.0.3    1.解决逐笔崩溃问题、解决逐笔与其他行情同时订阅崩溃问题     
                                  
v1.1.18.19-1.0.2    1.增加trade的SetHeartBeatInterval、GetTradingDay、GetApiVersion、GetClientIDByXTPID、GetAccountByXTPID接口

v1.1.18.19-1.0.1    1.添加subscribePublicTopic api 支持
                    2.trade接口的init方法增加publicTopic续传类型参数
                    3.扩充PositionEffectType、SideType枚举值，升级到xtp1.1.18.19
                    4.修复DepthMarketDataResponse中MarketDataType的转换可能存在的越界错误
                    5.修复OrderBookResponse、TickerPriceInfoResponse中ExchangeType的转换可能存在的越界错误
                    6.修复OTickerInfoResponse中ExchangeType、TickerType的转换可能存在的越界错误
                    7.修复TradeResponse中PositionEffectType的转换可能存在的越界错误
                    8.修改测试用例、demo程序、readme中trade的init方法的调用及参数说明
                 
v1.1.18.19-1.0.0    1.支持xtp api 1.1.18.19

##如何使用：

• 方式一：直接使用成品

  • 1）在项目根目录下手工拷贝动态库到系统目录

    linux：

      cp cpp/lib/linux/* /usr/local/lib/
      cp cpp/buildcpp/linux/libtradeplugin.so /usr/local/lib/
      cp cpp/buildcpp/linux/libquoteplugin.so /usr/local/lib/
    

    win64：

      copy cpp\lib\win64\dll\*  c:\windows\system32\
      copy cpp\buildcpp\win64\dll\tradeplugin.dll  c:\windows\system32\
      copy cpp\buildcpp\win64\dll\quoteplugin.dll  c:\windows\system32\
    

  • 2）确保有JRE8及以上被安装在目标主机，如果是windows还需要安装Visual C++ Redistributable for Visual Studio 2015，下载地址：
    https://www.microsoft.com/zh-CN/download/details.aspx?id=48145

  • 3）在量化交易java代码中引入build/libs/xtpapi-1.1.19.2.jar并使用

    如需进行单元测试：

      src/test/java/com.zts.xtp/trade/TradeApiTest.java是交易的单元测试：
      修改TradeApiTest.java：
      tradeApi.init((short)18, "23a71733bba3sd78722319b212e",
                 "/var/log/zts/xtp", XtpLogLevel.XTP_LOG_LEVEL_INFO, JniLogLevel.JNI_LOG_LEVEL_INFO, XtpTeResumeType.XTP_TERT_RESTART);
      sessionId = tradeApi.login("xx.xx.xx.xx", 1234,
                 "15001030", "xxxxxx", TransferProtocol.XTP_PROTOCOL_TCP);
      init方法的第1个参数是xtp client id（不超过255），实盘环境配置请联系官方人员获取，
               第2个参数为测试环境的serverkey，实盘环境请联系官方人员获取，
               第3个参数为java api产生的日志路径，
               第4个参数为java api交易日志级别，
               第5个参数为推送的续传方式,
      login方法的参数分别是测试xtp交易ip、xtp交易端口、资金账号、密码、传输方式(测试只支持TCP，实盘可配置TCP或UDP），
               请分别填入测试环境的参数及申请到的测试账号口令，实盘环境配置请联系官方人员获取。
                                    
      src/test/java/com.zts.xtp/quote/QuoteApiTest.java是行情的单元测试：
      修改QuoteApiTest.java：
      quoteApi.init((short)18,"/var/log/zts/xtp",XtpLogLevel.XTP_LOG_LEVEL_INFO, JniLogLevel.JNI_LOG_LEVEL_INFO, 6, 20480);
      int login_result = quoteApi.login("xx.xx.xx.xx",1234,"xxxxx","xxxxxx",1);
      login方法第1个参数为xtp行情ip、第2个参数为xtp行情端口、第3个参数为申请到的测试账号、第4个参数为账号密码，
              实盘环境的环境信息及资金账号请联系官方人员获取。
              
      上述参数也可以通过根目录下user.config.properites中配置。公网测试环境请使用TCP连接，UPD会收不到数据。
              
      执行./gradlew build -x test进行重新编译java生成build/libs/xtpapi-1.1.19.2.jar
      分别执行TradeApiTest、QuoteApiTest中的junit单元测试。
    

    如需进行demo测试：

      使用java ide导入xtp_api_demo工程，修改xtp_api_demo/src/main/java/com/zts/xtp/demo/Application.java
      修改如下参数（参考上面如需进行单元测试的说明）：
              private static final String XTP_TRADE_SERVER_IP = "xx.xx.xx.xx";//xtp交易server的ip
              private static final int XTP_TRADE_SERVER_PORT = 1234;//xtp交易server的端口
              private static final String TRADE_KEY = "23a71733bba3sd78722319b212e";//xtp交易serverkey
              private static final short CLIENT_ID = 18;//xtp允许的clientid
              private static final String XTP_QUOTE_SERVER_IP = "xx.xx.xx.xx";//xtp行情server的ip
              private static final int XTP_QUOTE_SERVER_PORT = 1234;//xtp行情server的端口
              private static final String ACCOUNT = "xxxxxx";//xtp资金账号
              private static final String PASSWORD = "xxxxxx";//xtp密码
              private static final String DATA_FOLDER = "/var/log/zts/xtp";//java api输出日志的本地目录
              .......
      运行Application.java即可，上述参数也可以通过根目录下user.config.properites中配置。公网测试环境请使用TCP连接，UPD会收不到数据。
    

• 方式二：源码编译后使用（用于当方式一无法正常使用或需要修改源码时）

  • 1）安装C++编译工具

    linux：yum install -y gcc 或apt-get install -y gcc

    mac: xcode-select --install 或 安装brew并用brew install gcc@7

    win：安装visual stuido 2015

  • 2）安装cmake

    linux：yum install -y cmake 或apt-get install -y cmake

    mac: http://www.cmake.org/download/下载cmake-3.13.2.tar.gz 解压tar-zxvf cmake-3.13.2.tar.gz，进入解压目录后，sudo ./bootstrap && sudo make && sudo make install

    win：下载安装https://github.com/Kitware/CMake/releases/download/v3.13.2/cmake-3.13.2-win32-x86.msi、安装visual studio(2005及以上)

  • 3）安装jdk8

    根据系统安装对应jdk https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

  • 4）编译jni部分2个plugin动态库，在工程根目录下的mkdir cpp/build

    如果是linux或mac：

    进入到cpp/build目录执行cmake .. 则继续执行 make&&make install 进行编译和安装 则在/usr/local/lib下会新增5个动态库：

      linux：libglog.so、libxtptraderapi.so、libxtpquoteapi.so、libtradeplugin.so、libquoteplugin.so
      
      mac：libglog.dylib、libxtptraderapi.dylib、libxtpquoteapi.dylib、libtradeplugin.dylib、libquoteplugin.dylib
    

    如果是Win：

    打开CMake GUI，where is the source code选项目下cpp目录，where to build libraries选cpp/build目录, 点configure在弹出的对话框中， specify the generator for this project选择本机Visual stuido对应的版本（请务必先手工打开visual studio，防止license过期等导致不可用进而执行cmake失败）， 注意如果要编译64位，一定要选择有Win64字样的选项，如Visual Studio 14 2015 Win64, 点击finish，点击configure右侧的generate，回到cpp/build目录下回生成cpp.sln文件即为visual stuidio的工程文件。 先用管理员权限打开visual studio，然后打开cpp.sln，打开后在cpp解决方案点右键点生成解决方案， 若编译都通过，然后选择名为install的工程右键执行生成（若报error MSB3073: 命令“setlocal错误，说明visual studio没有用管理员权限打开，无法写入系统目录，重新用管理员权限打开再执行生成即可）， 若扔不能通过install工程生成正确，执行则需要手工将编译生成2个plugin dll从cpp\build\Release拷贝到c:\windows\system32\，将cpp/lib/win32或win64/dll/下的3个dll也拷贝到c:\windows\system32\
    注：cpp/buildWin32和buildWin64是按照Visual studio2015生成的工程目录，若不能正常使用，请按上述方式在build目录自行生成工程文件。 注意visual studio中工具条Debug和Release版本的切换，当前选中哪个，执行生成解决方案就编译的哪个版本，生产环境建议采用Release版本以获取更高的性能。

    则在/usr/local/lib或c:\windows\system32\下会新增5个动态库：

       win：glog.dll、xtptraderapi.dll、xtpquoteapi.dll、tradeplugin.dll、quoteplugin.dll
    

  • 5）安装并配置gradle

  • 6）在工程根目录下执行./gradlew build -x test 执行成功后在项目根目录生成build/libs/xtpapi-1.1.19.2.jar

  • 7）在量化交易java代码中引入build/libs/xtpapi-1.1.19.2.jar并使用（注意如果在IDE中打开java代码及java测试用例，需要 在IDE中安装lombok插件才能看源码不报错，如果不看源码与测试用例，无需安装）

    如需进行单元测试：

    src/test/java/com.zts.xtp/trade/TradeApiTest.java是交易的单元测试：
    修改TradeApiTest.java：
    tradeApi.init((short)18, "23a71733bba3sd78722319b212e",
                            "/var/log/zts/xtp", XtpLogLevel.XTP_LOG_LEVEL_INFO, JniLogLevel.JNI_LOG_LEVEL_INFO, XtpTeResumeType.XTP_TERT_RESTART);
    sessionId = tradeApi.login("xx.xx.xx.xx", 1234,
                                      "xxxxxx", "xxxxxx", TransferProtocol.XTP_PROTOCOL_TCP);
    init方法的第1个参数是xtp client id（不超过255），实盘环境配置请联系官方人员获取，
             第2个参数为测试环境的serverkey，实盘环境请联系官方人员获取，
             第3个参数为java api产生的日志路径，
             第4个参数为java api交易日志级别，
             第5个参数为推送的续传方式，
    login方法的参数分别是测试xtp交易ip、xtp交易端口、资金账号、密码、传输方式(测试只支持TCP，实盘可配置TCP或UDP），请分别
             填入测试环境的参数及申请到的测试账号口令，实盘环境配置请联系官方人员获取。
                            
    src/test/java/com.zts.xtp/quote/QuoteApiTest.java是行情的单元测试：
    修改QuoteApiTest.java：
    quoteApi.init((short)18,"/var/log/zts/xtp",XtpLogLevel.XTP_LOG_LEVEL_INFO, JniLogLevel.JNI_LOG_LEVEL_INFO, 6, 20480);
    int login_result = quoteApi.login("23a71733bba3sd78722319b212e",1234,"xxxxxx","xxxxxx",1);
    login方法第1个参数为xtp行情ip、第2个参数为xtp行情端口、第3个参数为申请到的测试账号、第4个参数为账号密码，
             实盘环境的环境信息及资金账号请联系官方人员获取。
             
    上述参数也可以通过根目录下user.config.properites中配置。公网测试环境请使用TCP连接，UPD会收不到数据。
             
    执行./gradlew build -x test进行重新编译java生成build/libs/xtpapi-1.1.19.2.jar
    分别执行TradeApiTest、QuoteApiTest中的junit单元测试。
    

    如需进行demo测试：

    使用java ide导入xtp_api_demo工程，修改xtp_api_demo/src/main/java/com/zts/xtp/demo/Application.java
    修改如下参数（参考上面如需进行单元测试的说明）：
             private static final String XTP_TRADE_SERVER_IP = "xx.xx.xx.xx";//xtp交易server的ip
             private static final int XTP_TRADE_SERVER_PORT = 1234;//xtp交易server的端口
             private static final String TRADE_KEY = "23a71733bba3sd78722319b212e";//xtp交易serverkey
             private static final short CLIENT_ID = 18;//xtp允许的clientid
             private static final String XTP_QUOTE_SERVER_IP = "xx.xx.xx.xx";//xtp行情server的ip
             private static final int XTP_QUOTE_SERVER_PORT = 1234;//xtp行情server的端口
             private static final String ACCOUNT = "xxxxxx";//xtp资金账号
             private static final String PASSWORD = "xxxxxx";//xtp密码
             private static final String DATA_FOLDER = "/var/log/zts/xtp";//java api输出日志的本地目录
             ......
    运行Application.java即可，上述参数也可以通过根目录下user.config.properites中配置。公网测试环境请使用TCP连接，UPD会收不到数据。
    

#修改JNI代码调用流程

API调用，即JAVA -> C++：以下单为例

    1.业务代码调用tradeApi.insertOrder
    2.TradeApi.java的 public native String insertOrder(int orderXtpId, int orderClientId, int tickerL, int tickerN, int marketType, double price, double stopPrice, long quantity, int priceType, int sideType, int positionEffectType, int businessType, long sessionIdH, long sessionIdE, long tid); 注意同步修改注释
    3.com_zts_xtp_trade_api_TradeApi.h的JNIEXPORT jstring JNICALL Java_com_zts_xtp_trade_api_TradeApi_insertOrder(JNIEnv *, jobject, jint, jint, jint, jint, jint, jdouble, jdouble, jlong, jint, jint, jint, jint, jlong, jlong, jlong); 注意同步修改注释
    4.XtpTradeApi.h中实现api：（对java->c++的api调用需要实现，对c++->java的spi无需实现）
        uint64_t InsertOrder(XTPOrderInsertInfo order, uint64_t session_id)
        {
            ...
           return api_->InsertOrder(&order, session_id);
        }
    5.XtpTradeAdapter.cpp中实现：
        jstring JNICALL Java_com_zts_xtp_trade_api_TradeApi_insertOrder(JNIEnv *env, jobject obj, jint orderXtpId, jint orderClientId, jint tickerL, jint tickerN, jint marketType, jdouble price, jdouble stopPrice, jlong quantity, jint priceType, jint sideType, jint positionEffectType, jint businessType, jlong strSessionIdH, jlong strSessionIdE, jlong tid)
        中调用上一步实现的函数uint64_t orderId = ptrade->InsertOrder(orderInfo, sessionId);

SPI调用，即C++ -> JAVA：以收成交回报为例

    1.XtpTradeApi.h中定义    void OnTradeEvent(XTPTradeReport *trade_info, uint64_t session_id);
    2.XtpTradeApi.cpp中实现 void Trade::OnTradeEvent(XTPTradeReport *trade_info, uint64_t session_id) 
        {
            ... 将c++数据通过jni调用在java层构造出来
            envTrade2->CallVoidMethod(trade_plugin_obj_, jm_eventTrade2, orderXtpIdH, orderXtpIdE, trade_info->order_client_id, nTicker, nTickerLength, trade_info->market,
                                         localOrderIdH, localOrderIdE, execId, trade_info->price, trade_info->quantity, trade_info->trade_time, trade_info->trade_amount,
                                         reportIndexH, reportIndexE, orderExchId, trade_info->trade_type, trade_info->side, trade_info->position_effect, trade_info->business_type,
                                         branchPbu, 0, true, strSessionIdH, strSessionIdE); 调用java层TradeSpi.java的onTradeEvent接口

        }
    3.TradeSpi.java定义spi接口 void onTradeEvent(String orderXtpId, int orderClientId, String ticker, int marketType, String localOrderId, String execId,
                                                 double price, long quantity, long tradeTime, double tradeAmount, String reportIndex, String orderExchId,
                                                 char tradeType, int sideType, int positionEffectType, int businessType, String branchPbu, int requestId,
                                                 boolean lastResp, String sessionId);
    4.TradeApi.java定义供C++调用的接口，内部再转调spi的方法
        private void onTradeEvent(long orderXtpIdH, long orderXtpIdE, int orderClientId, int nTicker,int nTickerLength,
                                      int marketType, long localOrderIdH, long localOrderIdE, String execId,
                              double price, long quantity, long tradeTime, double tradeAmount, long reportIndexH, long reportIndexE, String orderExchId,
                              char tradeType, int sideType, int positionEffectType, int businessType, String branchPbu, int requestId,
                              boolean lastResp, long sessionIdH, long sessionIdE) {
                String ticker = tickerStringMapCache.getTickerFromTickerStringMapCache(nTicker, nTickerLength);
                String orderXtpId = String.valueOf(orderXtpIdH).concat(String.valueOf(orderXtpIdE));
                String localOrderId = String.valueOf(localOrderIdH).concat(String.valueOf(localOrderIdE));
                String reportIndex = String.valueOf(reportIndexH).concat(String.valueOf(reportIndexE));
                String sessionId = String.valueOf(sessionIdH).concat(String.valueOf(sessionIdE));
        
                tradeSpi.onTradeEvent(orderXtpId, orderClientId, ticker, marketType, localOrderId, execId, price, quantity,
                        tradeTime, tradeAmount, reportIndex, orderExchId, tradeType, sideType, positionEffectType, businessType,
                        branchPbu, requestId, lastResp, sessionId);
            }
    5.业务代码实现onTradeEvent接口

#License

Licensed under the MIT License.

#Remark

develop_optimization分支目前对应smart生产