# TBSDemo

**Repository Path**: xuyfcodecloud/TBSDemo

## Basic Information

- **Project Name**: TBSDemo
- **Description**: TBS腾讯浏览服务集成Demo
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-06
- **Last Updated**: 2021-12-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 序言
腾讯浏览服务功能强大，稳定，集成还算是比较简单的，比原生的webview强。最主要的是可以浏览PDF，Word文档，方便不少。此篇文章主要不是在讲集成，虽然集成的篇幅多些，但是我写的最重要的目的是我在实际使用过程中碰到的问题，以及解决方案。如果已经成功集成的了，可直接看其他问题，可能会有你想要的。以下是动态集成TBS，如果想要静态集成，请参考我的另一篇文章[TBS腾讯浏览服务静态集成，亲测可用，有demo](https://blog.csdn.net/Mr_JingFu/article/details/111864734)。

### TBS腾讯浏览服务接入

[TBS文档接入地址](https://x5.tencent.com/docs/access.html)

基本上的话照着这个文档接入是没有什么问题的，但是打开本地文件的时候，还是出现了一点小问题，因为文档里面没有说明。



### 基础配置

现在的Android开发都使用Android Studio了，所以只需要在app的build.gradle里面添加依赖，这份文章的日期是2020/9/30，最新id版本是下面这个

```java
api 'com.tencent.tbs.tbssdk:sdk:43939'
```

#### 权限配置

```java
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
```

#### 混淆配置

```java
-dontwarn dalvik.**
-dontwarn com.tencent.smtt.**

-keep class com.tencent.smtt.** {
    *;
}

-keep class com.tencent.tbs.** {
    *;
}
```

#### 异常上报配置

为了提高合作方的webview场景稳定性，及时发现并解决x5相关问题，当客户端发生crash等异常情况并上报给服务器时请务必带上x5内核相关信息。x5内核异常信息获取接口为：com.tencent.smtt.sdk.WebView.getCrashExtraMessage(context)。以bugly日志上报为例：

```java
UserStrategy strategy = new UserStrategy(appContext);
　　strategy.setCrashHandleCallback(new CrashReport.CrashHandleCallback() {
　　　　public Map<String, String> onCrashHandleStart(
            int crashType, 
            String errorType, 
            String errorMessage, 
            String errorStack) {

            LinkedHashMap<String, String> map = new LinkedHashMap<String, String>();
            String x5CrashInfo = com.tencent.smtt.sdk.WebView.getCrashExtraMessage(appContext);
            map.put("x5crashInfo", x5CrashInfo);
            return map;
　　　　}
　　　　@Override
　　　　public byte[] onCrashHandleStart2GetExtraDatas(
            int crashType, 
            String errorType, 
            String errorMessage, 
            String errorStack) {
            try {
                return "Extra data.".getBytes("UTF-8");
            } catch (Exception e) {
                return null;
            }
　　　　}
　　});

　　CrashReport.initCrashReport(appContext, APPID, true, strategy);
```

#### 首次初始化冷启动优化

TBS内核首次使用和加载时，ART虚拟机会将Dex文件转为Oat，该过程由系统底层触发且耗时较长，很容易引起anr问题，解决方法是使用TBS的 ”dex2oat优化方案“。

（1）. 设置开启优化方案

```java
// 在调用TBS初始化、创建WebView之前进行如下配置 
HashMap map = new HashMap(); 
map.put(TbsCoreSettings.TBS_SETTINGS_USE_SPEEDY_CLASSLOADER, true); 
map.put(TbsCoreSettings.TBS_SETTINGS_USE_DEXLOADER_SERVICE, true); 
QbSdk.initTbsSettings(map);
```

（2）. 增加Service声明

1. 在AndroidManifest.xml中增加内核首次加载时优化Service声明。
2. 该Service仅在TBS内核首次Dex加载时触发并执行dex2oat任务，任务完成后自动结束。

```java
<service 
android:name="com.tencent.smtt.export.external.DexClassLoaderProviderService"
android:label="dexopt"
android:process=":dexopt" >
</service>
```

#### 初始化X5内核

```java
 QbSdk.setDownloadWithoutWifi(true);
    QbSdk.setTbsListener(
        new TbsListener() {
          @Override
          public void onDownloadFinish(int i) {
            Log.d("QbSdk", "onDownloadFinish -->下载X5内核完成：" + i);
          }

          @Override
          public void onInstallFinish(int i) {
            Log.d("QbSdk", "onInstallFinish -->安装X5内核进度：" + i);
          }

          @Override
          public void onDownloadProgress(int i) {
            Log.d("QbSdk", "onDownloadProgress -->下载X5内核进度：" + i);
          }
        });

    QbSdk.PreInitCallback cb =
        new QbSdk.PreInitCallback() {
          @Override
          public void onViewInitFinished(boolean arg0) {
            // x5內核初始化完成的回调，true表x5内核加载成功，否则表加载失败，会自动切换到系统内核。
            Log.d("QbSdk", " 内核加载 " + arg0);
          }

          @Override
          public void onCoreInitFinished() {}
        };

    // x5内核初始化接口
    QbSdk.initX5Environment(getApplicationContext(), cb);
```

### WebView接入

这部分其实就是将原生webview的东西全部换成带有com.tencent.smtt包名的，TBS文档上有介绍，这里就不做说明了。

### 文件接入

这个应该才是重点。

#### 在APP内部打开文件
APP内部打开使用的是TBS里面的TbsReaderView，在我Demo中有示例。可以看我的[TBSDemo](https://github.com/CaiJinFu/TBSDemo.git)

#### 使用TBS的openFileReader打开文件

##### 支持格式

TBS已提供9种主流文件格式的本地打开，如果您需要使用更高级的能力请使用QQ浏览器打开文件

- 接入TBS可支持打开文件格式：`doc、docx、ppt、pptx、xls、xlsx、pdf、txt、epub`
- 调用QQ浏览器可打开：`rar（包含加密格式）、zip（包含加密格式）、tar、bz2、gz、7z（包含加密格式）、doc、docx、ppt、pptx、xls、xlsx、txt、pdf、epub、chm、html/htm、xml、mht、url、ini、log、bat、php、js、lrc、jpg、jpeg、png、gif、bmp、tiff 、webp、mp3、m4a、aac、amr、wav、ogg、mid、ra、wma、mpga、ape、flac`

##### 接口介绍

```Java
public static int openFileReader(
    Context context, 
    String filePath, 
    HashMap<String, String> extraParams,
    ValueCallback<String> callback
)
```

（1）此方法在`Qbsdk`类下

（2）调用之后，优先调起 QQ 浏览器打开文件。如果没有安装 QQ 浏览器，在 X5 内核下调起简版 QB 打开文 件。如果使用的系统内核，则调起文件阅读器弹框。

（3）暂时只支持本地文件打开

`context`: 调起 `miniqb` 的 `Activity` 的 `context`。此参数只能是 `activity` 类型的 `context`，不能设置为 `Application` 的 context。 `filePath`: 文件路径。格式为 `android` 本地存储路径格式，例如:`/sdcard/Download/xxx.doc`. 不支持 `file:///` 格式。暂不支持在线文件。 `extraParams`: `miniqb` 的扩展功能。为非必填项，若无需特殊配置，`默认可传入null`。扩展功能参考“文件功能定制” `ValueCallback`: 提供 `miniqb` 打开/关闭时给调用方回调通知,以便应用层做相应处理，您可以在出现以下回调时结束您的进程，节约内存占用。主要回调值如下：

```java
filepath error
TbsReaderDialogClosed 
default browser
fileReaderClosed
```

返回值：

```java
1:用 QQ 浏览器打开
2:用 MiniQB 打开
3:调起阅读器弹框
-1:filePath 为空 打开失败 
```

```java
public static void closeFileReader(Context context)
```

主动关闭文件打开ui,并清理相应内存占用。

##### 接入示例

```java
HashMap<String, String> params = new HashMap<String, String>(); 
params.put("style", "1"); 
params.put("local", "true"); 
params.put("memuData", jsondata); 
QbSdk.openFileReader(ctx,”/sdcard/xxx.doc”, params,callback);
```

到这你以为就能顺利打开浏览文件了吗？还是太年轻了，腾讯的文档不给你挖点坑，让你养成自己解决bug的习惯是不会罢休的。当你满心欢喜调用QbSdk.openFileReade的时候，log会给你报一个错。

```java
QbSdk: Must declare com.tencent.smtt.utils.FileProvider in AndroidManifest above Android 7.0,please view document in x5.tencent.com
```

意思就是让你在AndroidManifest.xml中添加provider，因为Android版本7.0访问文件的方式改变了。这时候添加一下就可以了。

首先在AndroidManifest.xml添加以下代码

```java
    <provider
      android:name="com.tencent.smtt.utils.FileProvider"
      android:authorities="${applicationId}.provider"
      android:exported="false"
      android:grantUriPermissions="true">
      <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/x5webview_file_paths" />
    </provider>

```

然后在res文件夹下创建xml文件夹，如果有了则跳过，接着再创建一个x5webview_file_paths.xml的文件，内容如下

```java
<?xml version="1.0" encoding="utf-8"?>
<paths>
    <external-path name="sdcard" path="."/>
</paths>
```

再运行，应该是没有问题的了，这里需要保证的是文件的路径是要对的，因为不能在线浏览，只能把文件下载到本地才能调用。这个错误我看了很久的文档都没有找到，后面在网上搜索，给出了以下的代码，

```java
<provider
    android:name="com.tencent.smtt.utils.FileProvider"
    android:authorities="包名.fileprovider"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/xml文件名" />
</provider>
```

这错就错在android:authorities="包名.fileprovider"，因为后来我去调用服务开启的QbSdk的类中，看这个错误发生的时机，发现他们是通过类型+“.provider”来校验的，所以只要改成android:authorities="包名.provider"就可以了，这个错误调试了很久，还是得在源码中才能发现春天。

### 其他问题

#### 使用TbsReaderView浏览文件夜间模式问题
我在使用小米10至尊版的时候，我的APP中没有适配深黑模式，使用的主题是Theme.AppCompat.Light.NoActionBar，但是小米10还是强制性的把我的APP使用了深黑模式。并且我发现，不止是我的APP，而是我手机上所有的APP都是如此，不管有没有适配，都使用了深黑模式，也就是夜间模式。这就导致了一个问题，使用TbsReaderView来浏览文件的时候，背景是黑色的，字体的颜色也是有点黑，导致文档看的不清楚，后来我在阅读TbsReaderView源码的时候，发现可以设置强制不使用夜间模式。加入以下代码即可。

```java
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
      //不使用黑暗模式
      mTbsReaderView.setForceDarkAllowed(false);
    }
```

#### targetAPI为29时

如果Android的targetSdkVersion是29的话，需要在application下面配置android:requestLegacyExternalStorage="true"

#### targetAPI为Android P时无法下载内核？

由于内核下载安装和查询是否可用需要向后台发送请求，目前还有部分请求为http格式，当targetAPI为28时非Https请求将会被block，会导致部分内核功能异常。您可以手动降低targetAPi到27及以下或者在您的AndroidManifst.xml中的Application标签中添加

```java
android:networkSecurityConfig="@xml/network_security_config"
```

并在app的res/xml目录中添加network_security_config.xml文件，文件内容为

```java
<?xml version="1.0" encoding="utf-8"?>
<network-security-config>
<base-config cleartextTrafficPermitted="true" />
</network-security-config>
```

由于内核初始化需要时间，在这段时间里需要等待一会再打开文件浏览，否则会加载失败。假如出现加载失败，卸载重新安装。

#### 无法下载，或者加载不成功
```java
    QbSdk.setTbsListener(
        new TbsListener() {
          @Override
          public void onDownloadFinish(int i) {
            //下载结束时的状态，下载成功时errorCode为100,其他均为失败，外部不需要关注具体的失败原因
            Log.d("QbSdk", "onDownloadFinish -->下载X5内核完成：" + i);
          }

          @Override
          public void onInstallFinish(int i) {
            //安装结束时的状态，安装成功时errorCode为200,其他均为失败，外部不需要关注具体的失败原因
            Log.d("QbSdk", "onInstallFinish -->安装X5内核进度：" + i);
          }

          @Override
          public void onDownloadProgress(int i) {
            //下载过程的通知，提供当前下载进度[0-100]
            Log.d("QbSdk", "onDownloadProgress -->下载X5内核进度：" + i);
          }
        });

```
上面是下载的监听，但是在实际中我经常发现onDownloadFinish返回是110，或者120等。官网上注明只有100是成功。只要不是100，则X5内核加载肯定是失败的。但是官网又没有说如何解决。没办法只能自己找出路。在十分艰难阅读了大部分带有混淆的TBS的jar包后，连猜带蒙的我找到了TbsDownloader.startDownload(this);这个方法。可以实现重新下载，但是如果只是重新下载了还是不一定能保证x5的加载是一定成功的。所以我又找到了QbSdk.reset(this);这个方法。可以重置x5的配置。kill掉APP后就会重新下载跟初始化。在实际线上的使用情况是十分复杂的，有的人还没等下载结束就把APPkill掉了，导致下载没完成，或者是下载完成加载没完成，所以只是使用TbsDownloader.startDownload(this);重新下载的话要结合QbSdk.setTbsListener里的回调，还有QbSdk.PreInitCallback的回调来综合判断。

```java
    QbSdk.PreInitCallback cb =
        new QbSdk.PreInitCallback() {
          @Override
          public void onViewInitFinished(boolean arg0) {
            // x5內核初始化完成的回调，true表x5内核加载成功，否则表加载失败，会自动切换到系统内核。
            Log.d("QbSdk", " 内核加载 " + arg0);
          }

          @Override
          public void onCoreInitFinished() {
            //内核初始化完毕
            Log.d("QbSdk", "内核初始化完毕");
          }
        };

```

QbSdk.reset(this);是最好的方法，简单粗暴。可以查看我的demo，里面有我认为比较好的解决方法。当然还是得根据自身的需求要使用。

#### 混淆无法使用
如果使用了混淆，则要加入以下混淆的规则
```java
#-optimizationpasses 7
#-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
-dontoptimize
-dontusemixedcaseclassnames
-verbose
-dontskipnonpubliclibraryclasses
-dontskipnonpubliclibraryclassmembers 
-dontwarn dalvik.**
-dontwarn com.tencent.smtt.**
#-overloadaggressively

# ------------------ Keep LineNumbers and properties ---------------- #
-keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,*Annotation*,EnclosingMethod
# --------------------------------------------------------------------------

# Addidional for x5.sdk classes for apps

-keep class com.tencent.smtt.export.external.**{
    *;
}

-keep class com.tencent.tbs.video.interfaces.IUserStateChangedListener {
	*;
}

-keep class com.tencent.smtt.sdk.CacheManager {
	public *;
}

-keep class com.tencent.smtt.sdk.CookieManager {
	public *;
}

-keep class com.tencent.smtt.sdk.WebHistoryItem {
	public *;
}

-keep class com.tencent.smtt.sdk.WebViewDatabase {
	public *;
}

-keep class com.tencent.smtt.sdk.WebBackForwardList {
	public *;
}

-keep public class com.tencent.smtt.sdk.WebView {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.WebView$HitTestResult {
	public static final <fields>;
	public java.lang.String getExtra();
	public int getType();
}

-keep public class com.tencent.smtt.sdk.WebView$WebViewTransport {
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.WebView$PictureListener {
	public <fields>;
	public <methods>;
}


-keepattributes InnerClasses

-keep public enum com.tencent.smtt.sdk.WebSettings$** {
    *;
}

-keep public enum com.tencent.smtt.sdk.QbSdk$** {
    *;
}

-keep public class com.tencent.smtt.sdk.WebSettings {
    public *;
}


-keepattributes Signature
-keep public class com.tencent.smtt.sdk.ValueCallback {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.WebViewClient {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.DownloadListener {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.WebChromeClient {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.WebChromeClient$FileChooserParams {
	public <fields>;
	public <methods>;
}

-keep class com.tencent.smtt.sdk.SystemWebChromeClient{
	public *;
}
# 1. extension interfaces should be apparent
-keep public class com.tencent.smtt.export.external.extension.interfaces.* {
	public protected *;
}

# 2. interfaces should be apparent
-keep public class com.tencent.smtt.export.external.interfaces.* {
	public protected *;
}

-keep public class com.tencent.smtt.sdk.WebViewCallbackClient {
	public protected *;
}

-keep public class com.tencent.smtt.sdk.WebStorage$QuotaUpdater {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.WebIconDatabase {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.WebStorage {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.DownloadListener {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.QbSdk {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.QbSdk$PreInitCallback {
	public <fields>;
	public <methods>;
}
-keep public class com.tencent.smtt.sdk.CookieSyncManager {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.Tbs* {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.utils.LogFileUtils {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.utils.TbsLog {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.utils.TbsLogClient {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.CookieSyncManager {
	public <fields>;
	public <methods>;
}

# Added for game demos
-keep public class com.tencent.smtt.sdk.TBSGamePlayer {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.TBSGamePlayerClient* {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.TBSGamePlayerClientExtension {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.sdk.TBSGamePlayerService* {
	public <fields>;
	public <methods>;
}

-keep public class com.tencent.smtt.utils.Apn {
	public <fields>;
	public <methods>;
}
-keep class com.tencent.smtt.** {
	*;
}
# end


-keep public class com.tencent.smtt.export.external.extension.proxy.ProxyWebViewClientExtension {
	public <fields>;
	public <methods>;
}

-keep class MTT.ThirdAppInfoNew {
	*;
}

-keep class com.tencent.mtt.MttTraceEvent {
	*;
}

# Game related
-keep public class com.tencent.smtt.gamesdk.* {
	public protected *;
}

-keep public class com.tencent.smtt.sdk.TBSGameBooter {
        public <fields>;
        public <methods>;
}

-keep public class com.tencent.smtt.sdk.TBSGameBaseActivity {
	public protected *;
}

-keep public class com.tencent.smtt.sdk.TBSGameBaseActivityProxy {
	public protected *;
}

-keep public class com.tencent.smtt.gamesdk.internal.TBSGameServiceClient {
	public *;
}
#---------------------------------------------------------------------------


#------------------  下方是android平台自带的排除项，这里不要动         ----------------

-keep public class * extends android.app.Activity{
	public <fields>;
	public <methods>;
}
-keep public class * extends android.app.Application
{
	public <fields>;
	public <methods>;
}
-keep public class * extends android.app.Service
-keep public class * extends android.content.BroadcastReceiver
-keep public class * extends android.content.ContentProvider
-keep public class * extends android.app.backup.BackupAgentHelper
-keep public class * extends android.preference.Preference

-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

-keepclasseswithmembers class * {
	public <init>(android.content.Context, android.util.AttributeSet);
}

-keepclasseswithmembers class * {
	public <init>(android.content.Context, android.util.AttributeSet, int);
}

-keepattributes *Annotation*

-keepclasseswithmembernames class *{
	native <methods>;
}

-keep class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator *;
}

#------------------  下方是共性的排除项目         ----------------
# 方法名中含有“JNI”字符的，认定是Java Native Interface方法，自动排除
# 方法名中含有“JRI”字符的，认定是Java Reflection Interface方法，自动排除

-keepclasseswithmembers class * {
    ... *JNI*(...);
}

-keepclasseswithmembernames class * {
	... *JRI*(...);
}

-keep class **JNI* {*;}


```

[集成Demo地址](https://github.com/CaiJinFu/TBSDemo.git)

欢迎订阅[我的博客](https://blog.csdn.net/Mr_JingFu)，坚持总是会看到希望的。