接入智能教练SDK及参数设置

简要描述

主要协助第三方App接入智能教练，并且设置相应参数的功能代码示例

主要内容

版本号：1.13.2beta

minSdk：21

引入方式:maven

支持的ABI:armeabi-v7a、arm64-v8a

代码设置

1、引入相关nexus服务 相关IP白名单配置请联系项目负责人

  1. maven{
  2.     allowInsecureProtocol = true
  3.     url 'https://devinner.yunxuetang.com.cn/nexus/content/repositories/releases/'}
  4. maven{
  5.     allowInsecureProtocol = true
  6.     url 'https://nexus-sdk.yunxuetang.com.cn/repository/maven-public/'}

2、引入智能教练库

  1. implementation("com.yxt.sdk.library_sparring:core:1.13.1")

3、添加SDK相关权限依赖

  1.     <!--连接网络权限，用于执行云端语音能力 -->
  2.     <uses-permission android:name="android.permission.INTERNET"/>
  3.     <!--获取手机录音机使用权限，听写、识别、语义理解需要用到此权限 -->
  4.     <uses-permission android:name="android.permission.RECORD_AUDIO"/>
  5.     <!--读取网络信息状态 -->
  6.     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
  7.     <!--获取当前wifi状态 -->
  8.     <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
  9.     <!--允许程序改变网络连接状态 -->
  10.     <uses-permission android:name="android.permission.CHANGE_NETWORK_STATE"/>
  11.     <!--读取手机信息权限 -->
  12.     <uses-permission android:name="android.permission.READ_PHONE_STATE"/>
  13.     <!--读取联系人权限，上传联系人需要用到此权限 -->
  14.     <uses-permission android:name="android.permission.READ_CONTACTS"/>
  15.     <!--外存储写权限，构建语法需要用到此权限 -->
  16.     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
  17.     <!--外存储读权限，构建语法需要用到此权限 -->
  18.     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
  19.     <!--手机定位信息，用来为语义等功能提供定位，提供更精准的服务-->
  20.     <!--摄相头权限，拍照需要用到 -->
  21.     <uses-permission android:name="android.permission.CAMERA" />

4、Webview配置自定义WebChromeClient用于解析协议智能教练的入口均为H5，原生与H5交互通过yxt协议通信 (JsPrompt)

  1. //可参考以下代码
  3. import android.net.Uri;
  4. import android.text.TextUtils;
  5. import android.webkit.JsPromptResult;
  6. import android.webkit.JsResult;
  7. import android.webkit.WebChromeClient;
  8. import android.webkit.WebView;
  9. import org.json.JSONObject;
  11. public class YxtWebChromeClient extends WebChromeClient {
  12.     @Override
  13.     public boolean onJsPrompt(WebView view, String url, String message, String defaultValue, JsPromptResult result) {
  14.         result.confirm();
  15.         Uri uri = Uri.parse(message);
  16.         String host = uri.getHost();
  17.         if (TextUtils.isEmpty(host))
  18.             return false;
  19.         String key_schema_3 = "yxtapp://";
  20.         if (message.startsWith(key_schema_3)) {
  21.             String keyParam = "param";
  22.             String param = uri.getQueryParameter(keyParam);
  24.             String name = getProtoPrm(param, "name");
  25.             switch (name){
  26.                 //AI智能陪练 开始陪练
  27.                 case "biz.sparring.start":
  28.                     String codeStart = getProtoPrm(param, "code");
  29.                     String isPreview = getProtoPrm(param, "isPreview");
  30.                     SparringUtils.openSparringService(view.getContext(),view,codeStart,isPreview,1);
  31.                     break;
  32.                 //AI智能陪练 练习回顾
  33.                 case "biz.sparring.review":
  34.                     String codeReview = getProtoPrm(param, "code");
  35.                     SparringUtils.openSparringService(view.getContext(),view,codeReview,"",2);
  36.                     break;
  37.                 //AI智能陪练 开始陪练
  38.                 case "biz.sparring.open":
  39.                     String codeOpen = getProtoPrm(param, "code");
  40.                     SparringUtils.openSparringService(view.getContext(),view,codeOpen,"",3);
  41.                     break;
  42.             }
  43.         }
  44.         return true;
  45.     }
  47.     @Override
  48.     public boolean onJsAlert(WebView webView, String s, String s1, JsResult jsResult) {
  49.         jsResult.confirm();
  50.         return true;
  51.     }
  53.     public static String getProtoPrm(String p, String key) {
  54.         String res = "";
  55.         try {
  56.             JSONObject j = new JSONObject(p);
  57.             if (j.isNull(key)) {
  58.                 res = "";
  59.             } else {
  60.                 res = j.optString(key, "");
  61.             }
  63.         } catch (Exception e) {
  64.             e.printStackTrace();
  65.         }
  66.         return res;
  67.     }
  69. }

5、协议解析成功后，获取到的相关参数进行初始化后打开智能教练SDK即可

  1. SparringUtils.openSparringService(view.getContext(),view,codeStart,isPreview,1);

工具类可参考以下代码

  2. import android.content.Context;
  3. import android.webkit.WebView;
  4. import com.yxt.sparring.SparringManager;
  5. import com.yxt.sparring.utils.http.StartType;
  7. /**
  8.  * create by yxtAdmin on 2022年02月16日16:04:05
  9.  * 智能教练工具类
  10.  */
  11. public class SparringUtils {
  13.     /**
  14.      * 打开智能教练
  15.      * @param context 上下文
  16.      * @param webView 加载器
  17.      * @param code 智能教练code码
  18.      * @param isPreview 是否为预览
  19.      * @param type 打开方式
  20.      */
  21.     public static void openSparringService(Context context, WebView webView, String code, String isPreview, int type) {
  22.         StartType startType = StartType.DEFAULT;
  23.         switch (type) {
  24.             case 1:
  25.                 startType = StartType.DEFAULT;
  26.                 break;
  27.             case 2:
  28.                 startType = StartType.REVIEW;
  29.                 break;
  30.             case 3:
  31.                 startType = StartType.OPEN_PAGE;
  32.                 break;
  33.             default:
  34.                 break;
  35.         }
  36.         initSparringManagerConfig(context,webView,code,isPreview,startType);
  37.     }
  39.     private static int environment = 1;// 1:测试 2:产线 3:预发布
  41.     /**
  42.      * 初始化智能教练
  43.      * @param mContext 上下文
  44.      * @param webView 加载器
  45.      * @param code 智能教练code码
  46.      * @param isPreview 是否位预览
  47.      * @param type 打开方式
  48.      */
  49.     public static void initSparringManagerConfig(Context mContext, WebView webView, String code, String isPreview, StartType type) {
  50.         if (!code.isEmpty()) {
  51.             //AI陪练初始化
  52.             SparringManager.SparringConfig config = new SparringManager.SparringConfig();
  53.             config.setEnableLog(true);
  54.             config.setSource("503");
  55.             config.setEnableReachabilityToast(false);
  56.             config.setSdkCloseCallBack(() -> {
  57.                 String js = "javascript:window.InterFaceForSP.sparringActive()";
  58.                 //sdk关闭回调js - H5协议
  59.                 webView.loadUrl(js);
  60.             });
  61.             if (environment == 1) {
  62.                 //测试
  63.                 config.setEnvironment(SparringManager.AISparringEnvironment.DEVELOPMENT);
  64.             } else if (environment == 2) {
  65.                 //产线
  66.                 config.setEnvironment(SparringManager.AISparringEnvironment.PRODUCTION);
  67.             } else if (environment == 3) {
  68.                 //预发布
  69.                 config.setEnvironment(SparringManager.AISparringEnvironment.STAGE);
  70.             }
  71.             SparringManager.INSTANCE.init(mContext, config,new ImageLoaderImp());
  72.             //调起sdk
  73.             SparringManager.INSTANCE.start(code, isPreview, type);
  74.         }
  75.     }
  76. }

为尽量避免项目编译、依赖冲突，图片加载能力由外部传入，可参考以下代码Glide

  1. package com.yxt.sparringintegrationdemo.utils;
  3. import android.content.Context;
  4. import android.graphics.drawable.Drawable;
  5. import android.widget.ImageView;
  7. import androidx.annotation.Nullable;
  9. import com.bumptech.glide.Glide;
  10. import com.bumptech.glide.load.DataSource;
  11. import com.bumptech.glide.load.engine.GlideException;
  12. import com.bumptech.glide.load.resource.gif.GifDrawable;
  13. import com.bumptech.glide.request.RequestListener;
  14. import com.bumptech.glide.request.target.Target;
  15. import com.yxt.sparring.utils.glide.IGlideLoad;
  16. import java.io.File;
  17. import java.util.concurrent.ExecutionException;
  19. /**
  20.  * create by yxtAdmin on 2022年02月18日14:31:35
  21.  * 图片加载实现类
  22.  */
  23. public class ImageLoaderImp implements IGlideLoad {
  24.     @Override
  25.     public void load(Context context, String url, ImageView view) {
  26.         Glide.with(context).load(url).into(view);
  27.     }
  29.     @Override
  30.     public void load(Context context, String url, ImageView view, LoadResultCallback loadResultCallback) {
  31.         Glide.with(context).load(url).listener(new RequestListener<Drawable>() {
  32.             @Override
  33.             public boolean onLoadFailed(@Nullable GlideException e, Object model, Target<Drawable> target, boolean isFirstResource) {
  34.                 if (loadResultCallback != null) {
  35.                     loadResultCallback.onFailure();
  36.                 }
  37.                 return false;
  38.             }
  40.             @Override
  41.             public boolean onResourceReady(Drawable resource, Object model, Target<Drawable> target, DataSource dataSource, boolean isFirstResource) {
  42.                 if (loadResultCallback != null) {
  43.                     loadResultCallback.onSuccess();
  44.                 }
  45.                 return false;
  46.             }
  47.         }).into(view);
  48.     }
  50.     @Override
  51.     public void loadGif(Context context, String url, ImageView view, LoadResultCallback loadResultCallback) {
  52.         Glide.with(context).asGif().load(url).listener(new RequestListener<GifDrawable>() {
  53.             @Override
  54.             public boolean onLoadFailed(@Nullable GlideException e, Object model, Target<GifDrawable> target, boolean isFirstResource) {
  55.                 if (loadResultCallback != null) {
  56.                     loadResultCallback.onFailure();
  57.                 }
  58.                 return false;
  59.             }
  61.             @Override
  62.             public boolean onResourceReady(GifDrawable resource, Object model, Target<GifDrawable> target, DataSource dataSource, boolean isFirstResource) {
  63.                 if (loadResultCallback != null) {
  64.                     loadResultCallback.onSuccess();
  65.                 }
  66.                 return false;
  67.             }
  68.         }).into(view);
  70.     }
  72.     @Override
  73.     public void downloadOnly(Context context, String url) {
  74.         try {
  75.             Glide.with(context).downloadOnly().load(url).submit().get();
  76.         } catch (ExecutionException | InterruptedException e) {
  77.             e.printStackTrace();
  78.         }
  79.     }
  81.     @Override
  82.     public File getFile(Context context, String url) {
  83.         try {
  84.             return Glide.with(context).downloadOnly().load(url).submit().get();
  85.         } catch (ExecutionException | InterruptedException e) {
  86.             e.printStackTrace();
  87.         }
  88.         return null;
  89.     }
  90. }