服务端SDK

0.0.1. SDK的位置

源码在server/sdk目录,编译打包后在release包中的server_sdk目录中。在server_sdk目录下有2个jar包和一个说明。

0.0.2. 引入SDK

  1. 把release包中的两个jar包common-0.xx.jarsdk-0.xx.jar放到工程目录下,比如${ProjectPath}/src/lib目录下。
  2. 修改pom文件,在pom文件中加入如下依赖,注意修改jar包的路径

    <dependencies>
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
             <version>2.8.2</version>
         </dependency>
    
         <dependency>
             <groupId>commons-httpclient</groupId>
             <artifactId>commons-httpclient</artifactId>
             <version>3.1</version>
         </dependency>
    
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpclient</artifactId>
             <version>4.5.3</version>
         </dependency>
    
         <dependency>
             <groupId>commons-codec</groupId>
             <artifactId>commons-codec</artifactId>
             <version>1.11</version>
             <scope>compile</scope>
         </dependency>
    
         <dependency>
             <groupId>com.google.protobuf</groupId>
             <artifactId>protobuf-java</artifactId>
             <version>2.5.0</version>
         </dependency>
    
         <dependency>
             <groupId>cn.wildfirechat</groupId>
             <artifactId>sdk</artifactId>
             <version>0.20</version>
             <scope>system</scope>
             <systemPath>${project.basedir}/src/lib/sdk-0.20.jar</systemPath>
         </dependency>
    
         <dependency>
             <groupId>cn.wildfirechat</groupId>
             <artifactId>common</artifactId>
             <version>0.20</version>
             <scope>system</scope>
             <systemPath>${project.basedir}/src/lib/common-0.20.jar</systemPath>
         </dependency>
     </dependencies>
    
  3. 修改打包插件配置,确保打包时能把这两个jar包打进去,下面是springboot的修改,请参考。如果有问题,请百度解决。

    <!--# 由于添加了本地jar包,需要打包时把sdk和common打进去,下面是springboot项目添加includeSystemScope部分,其它类型项目请百度。 -->
     <build>
         <plugins>
             <plugin>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-maven-plugin</artifactId>
                 <configuration>
                     <includeSystemScope>true</includeSystemScope>
                 </configuration>
             </plugin>
         </plugins>
     </build>
    
  4. 编译打包,确保能够打包成功。

0.0.3. 使用SDK

  1. 首先需要初始化。在ChatConfig类里有三个函数,分别初始化Server API接口、Robot API接口和Channel API接口。

    ChatConfig.initAdmin(mIMConfig.admin_url, mIMConfig.admin_secret);
    ChatConfig.initRobot(mRobotConfig.im_url, mRobotConfig.getIm_id(), mRobotConfig.im_secret);
    ChatConfig.initChannel(mChannelConfig.im_url, mChannelConfig.getIm_id(), mChannelConfig.im_secret);
    

    Admin URL使用server API端口(默认是18080), Robot和Channel API使用http_port端口(默认是80)

  2. 调用不同的接口,来实现功能,比如获取userToken

    //使用用户id获取token
    IMResult<OutputGetIMTokenData> tokenResult = UserAdmin.getUserToken(user.getUserId(), clientId);
    if (tokenResult.getErrorCode() != ErrorCode.ERROR_CODE_SUCCESS) {
     LOG.error("Get user failure {}", tokenResult.code);
     return null;
    }
    return tokenResult.getResult().getToken();
    
  3. 使用说明 请参考源码${ProjectPath}/sdk/src/main/java/cn.wildfirechat.sdk.Main.java。如果有问题或者缺失,请提issue。

2018 © wildfirechat.cn 京ICP备18060403号-1 all right reserved,powered by Gitbook该文件修订时间: 2019-05-25 14:43:58

results matching ""

    No results matching ""