原创首发

使用WebView展示博客文章详情(syntaxhighlighter.js的简单使用)

π大星发表于 2021-08-13 22:04 2043

WebView syntaxhighlighter syntaxhighlighter.js android

使用WebView展示博客文章详情(syntaxhighlighter.js的简单使用)

刚开始开发博客文章详情，由于对于前端知识了解不熟悉，所以选择了使用原生的自定View来完成，但是在开发中发现该方案的成本和效果差强人意，所以改变方式使用WebView结合JS的方案来展示文章详情，既然对前端知识不是很熟悉，那就摸着石头过河，慢慢探索。大不了就是再多掉几根头发

观察网站的前端

按下F12查看文章详情页的网页源码

图片描述

可以发现代码和关键字是使用了<code>标签，并且代码块还带有class属性,第一个表示代码语言类型，及我们在书写md文档是添加的标注，那么hljs这个值代表的是什么意思呢，问一下度娘
搜索之后，第一条记录就是highlight.js的结果，刚好hljs就是这个库的简写，所以这个库应该对我们的需求有帮助，这是我第一次知道这个js库，紧接着就是开始搜索hightlight.js相关的资料，搜索的相关信息如下：

syntaxhighlighter这个库是我再搜索highlight库过程中找到的，因为前者可以在github下载资源，并通过本地加载进行文章的渲染，所以在这里选择了后者，接下来就是根据教程编写demo进行测试和学习：

测试与学习

下载资源

从github可以下载该js库的资源，然后将js、css放在assets目录下:

其中html文件夹下artile_template.html是文章的样板后面才会用到，article_demo.html是根据教程编写的demo，其代码如下:

    <html lang="en">
        <head>
            <meta charset="UTF-8">
            <title>Document</title>
            <link rel="stylesheet" type="text/css" href="SyntaxHighlighter/css/shCore.css">
            <link rel="stylesheet" type="text/css" href="SyntaxHighlighter/css/shThemeDjango.css">
            <script type="text/javascript" src="SyntaxHighlighter/js/XRegExp.js"></script>
            <script type="text/javascript" src="SyntaxHighlighter/js/shCore.js"></script>
            <script type="text/javascript" src="SyntaxHighlighter/js/shBrushJava.js"></script>
            <script type="text/javascript">
                SyntaxHighlighter.all()
                </script>
        </head>
        <body>
            <pre class="brush: java; collapse: false;">
                public void javaMethod() {
                    int i = 3;
                }
            </pre>
            <pre class="brush: java; collapse: false;">
                public static String utf8ToUnicode(String inStr) {
                    char[] myBuffer = inStr.toCharArray();
                    StringBuffer sb = new StringBuffer();
                    for (int i = 0; i < inStr.length(); i++) {
                        UnicodeBlock ub = UnicodeBlock.of(myBuffer[i]);
                        if(ub == UnicodeBlock.BASIC_LATIN){
                            //英文及数字等
                            sb.append(myBuffer[i]);
                        }else if(ub == UnicodeBlock.HALFWIDTH_AND_FULLWIDTH_FORMS){
                            //全角半角字符
                            int j = (int) myBuffer[i] - 65248;
                            sb.append((char)j);
                        }else{
                            //汉字
                            short s = (short) myBuffer[i];
                            String hexS = Integer.toHexString(s);
                            String unicode = "\\u"+hexS;
                            sb.append(unicode.toLowerCase());
                        }
                    }
                    return sb.toString();
                }
            </pre>
            <pre class="brush: java; collapse: true;">
                public void javaMethod() {
                int i = 3;
                }
            </pre>
            <pre class="brush: java; collapse: true;">
                public void javaMethod() {
                int i = 3;
                }
            </pre>
        </body>
    </html>

紧接着就是使用webview加载上面的html

    dataBinding.wvArticle.settings.javaScriptEnabled = true
    //getTestHtml("article_demo")：从assets目录下读取测试数据
    dataBinding.wvArticle.loadDataWithBaseURL("file:///android_asset/",getTestHtml("article_demo"), "text/html", "utf-8", null)

其加载结果如下：
关于学习、测试的总结：

上文只是讲述实现使用SyntaxHighlighter库展示代码的简单使用，下列总结时在开发中慢慢发现的一些特点，期间走了很多弯路，浪费了很多时间，但是这个库的更多用法还有待挖掘：

在demo实例中代码被<pre>标签包裹，这个标签时可以在shCore.js中修改的，该属性在77行，应为网站返回的数据中代码使被<code>标签包裹的，所以需要修改一下

    /** Name of the tag that SyntaxHighlighter will automatically look for.
        该代码高亮插件会自动寻找该标签 */
	tagName : 'code',

必须要加载样式文件，不同的样式文件带有不同的主题，并且可以自定义样式，这个在后面还会讲到

    <!-- 加载主题样式 -->
    <link rel="stylesheet" type="text/css" href="SyntaxHighlighter/css/shCore.css">
    <link rel="stylesheet" type="text/css" href="SyntaxHighlighter/css/shThemeDjango.css">

加载js文件时必须要加载XRegExp.js、shCore.js两个js文件和对应的不同语言类型的文件，语言类型的文件也可以自定义

    <script type="text/javascript" src="SyntaxHighlighter/js/XRegExp.js"></script>
    <script type="text/javascript" src="SyntaxHighlighter/js/shCore.js"></script>
    <!-- 加载需要渲染代码的类型 -->
    <script type="text/javascript" src="SyntaxHighlighter/js/shBrushJava.js"></script>
    <!-- 自定义渲染kotlin代码 -->
<script type="text/javascript" src="SyntaxHighlighter/js/shBrushKotlin.js"></script>

在代码块的标签<pre>可以通过控制class的值控制对应的功能：

class="brush: java; collapse: true;"
- brush: 指定code的类型，并需要加载对应的js文件，例如指定java，需要加载shBrushJava.js
- collapse: 是否默认收缩隐藏代码
- class-name：给高亮的标签新增一个类名
- first-line : 代码块开始的行号
- title: 代码块的标题会显示在代码块上方
- quick-code：双击是否可以复制和粘贴代码
- toolbar：是否使用工具条（启用，代码块右上方有个？方块，但是点击没什么反应）
- gutter：是否显示行号
关于class中使用的属性值很多，这里只是列举的几个，主要英语能力有限，测试其他属性发现变化并不明显，还有待大佬解析

适配网站博客文章

首先是html的模板，先引用js、css资源，和编写额为的自定义样式的css属性和一些js代码供后面拓展，如下：

<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Document</title>
    <!-- 引入css文件 -->
    <link rel="stylesheet" type="text/css" href="SyntaxHighlighter/css/shCore.css">
    <link rel="stylesheet" type="text/css" href="SyntaxHighlighter/css/shThemeArticle.css">
    <!-- 引入js文件，两面连个的引用顺序不可变 -->
    <script type="text/javascript" src="SyntaxHighlighter/js/XRegExp.js"></script>
    <script type="text/javascript" src="SyntaxHighlighter/js/shCore.js"></script>
    <script type="text/javascript" src="SyntaxHighlighter/js/shBrushJava.js"></script>
    <script type="text/javascript" src="SyntaxHighlighter/js/shBrushPowerShell.js"></script>
    <script type="text/javascript" src="SyntaxHighlighter/js/shBrushJScript.js"></script>
    <script type="text/javascript" src="SyntaxHighlighter/js/shBrushSql.js"></script>
    <script type="text/javascript" src="SyntaxHighlighter/js/shBrushXml.js"></script>
    <script type="text/javascript" src="SyntaxHighlighter/js/shBrushPlain.js"></script>
    <script type="text/javascript" src="SyntaxHighlighter/js/shBrushKotlin.js"></script>
    <script type="text/javascript">
        SyntaxHighlighter.all()
        // 给代码块设置监听事件，当点击时通知给ktolin
        function onTouchStart(e) {
            androidApi.touchEvent(0);
        }

        function onTouchEnd(e) {
            androidApi.touchEvent(2);
        }

        function onTouchMove(e) {
         androidApi.touchEvent(1);
        }
        function addTouchListener() {
            var dom = document.getElementsByClassName('code');
            androidApi.log(dom.length);
            for (i in dom){
                dom[i].addEventListener('touchstart', onTouchStart, false);
                dom[i].addEventListener('touchmove', onTouchMove, false);
                dom[i].addEventListener('touchend', onTouchEnd, false);
            }
        }
        </script>
    <style>
        /* 控制文章中的image不超过屏幕 */
        img {
            max-width: 100%;
        }
        /* 代码块的样式 */
        .code_block{
            display: block;
            overflow-x: auto;
            padding: .5em;
            background: #f0f0f0;
        }

        /* 文章中关键字的样式，及markdown中``修饰的文字 */
        .key_word{
            word-break: break-word;
            border-radius: 2px;
            margin-left: 3px;
            margin-right: 3px;
            overflow-x: auto;
            background-color: #f7f7f7;
            color: #ff502c;
            font-size: .87em;
            padding: .065em .4em!important;
            display: inline!important;
        }
    </style>
</head>
<body>
{{template}}
</body>
</html>

在获取到文章数据的基础上对文章内容进行处理：

首先时对关键字的处理，前文提到特殊关键字时被<code>标签包裹，我们在这里使用正则将其替换成<span>标签并添加属性key_word,代码如下：

    /**
    * content：网页返回的文章内容
    */
    private fun handleKeywords(content: String): String {
        var handleText = content
        val parttern = Regex("<code>(.*?)</code>")
        val results = parttern.findAll(handleText)
        for (result in results) {
            var keyString: String = result.value
            keyString = keyString.replace("<code>", "<span class=\"key_word\">")
            keyString = keyString.replace("</code>", "</span>")
            handleText = handleText.replace(result.value, keyString)
        }
        return handleText
    }

再是对代码块的处理,前文中代码块除了被<code>标签包裹以为，其中还带有代码语言类型的类名，所以需要将原先的类名进行转换，然后再此基础上加上其他属性的值来控制代码块的样式，也可以直接再shCore.js中进行全局控制，处理代码如下：

 /**
    * content：网页返回的文章内容
    */
    private fun handleHtmlContent(content: String): String {
        //处理文章内容中是关键字的情况
        val handleText = handleKeywords(content)
        //读取模板代码
        val template = getTestHtml("article_demo")
        //利用jsoup转化未html对象，方便处理
        val document = Jsoup.parse(template.replace("{{template}}",handleText))
        //使用递归处理html中的代码块
        verseChild(document.body())
        return document.toString()
    }

    private fun verseChild(body: Element?) {
    body?.let {
        for (child in body.children()) {
            if (child.tagName() == "code") {
                //给代码父标签添加属性，可以自定义样式
                child.parent().attributes().add("class", "code_block")
                //给code设置新的类名，来控制代码的属性
                child.attributes().put("class", "brush: ${getLanguageType(child.attr("class"))}; toolbar:false; quick-code:false;")
            }
            verseChild(child)
        }
    }
}

/**
 * 将原来内容中的代码类型属性进行转换
 */
private fun getLanguageType(attr: String): String {
    Log.d(TAG, "getLanguageType: $attr")
    if (attr.isEmpty()) {
        return "text"
    }else{
        return when(attr){
            "language-shell" -> "ps"
            "language-java" -> "java"
            "language-kotlin" -> "kotlin"
            "language-xml" -> "xml"
            "language-sql" -> "sql"
            "language-json" -> "text"
            else -> "text"
        }
    }
}

适配文章后的结果如下：

自定义样式、拓展语言类型、交互优化

syntaxhighlighter的资源下已经提供很多语言类型和文章主题，但是与网站的文章样式的差异较大，并且还不支持kotlin代码的渲染

自定义样式

打开资源中css文件，内容就是代码块的样式属性，但是里面某些类名的意思不是很清楚的，所以需要获取webview中的网页源代码，查看代码发生了什么变化，并且可以直接找到css中的类名修饰了那些html代码

获取webview中的网页源代码：

   class DemoJsApi {

        companion object{
            private const val TAG = "DemoJsApi"
        }

        @JavascriptInterface
        fun printPageSource(html: String?) {
            Log.d(TAG, "pageSource: $html")
            saveHtml(html!!)
        }

        private fun saveHtml(html: String) {
            val f = File("data/data/com.coder.zt.sobblog/result.html")
            if (!f.exists()) {
                f.createNewFile()
            }
            val fos = FileOutputStream(f)
            val input = OutputStreamWriter(BufferedOutputStream(fos))
            val bfReader = BufferedWriter(input)
            bfReader.write(html)
            bfReader.flush()
            bfReader.close()
        }
    }

    //为webview设置js接口
    dataBinding.wvArticle.addJavascriptInterface(DemoJsApi(), "androidApi")
    //调用js代码获取webview中的网页源代码
    dataBinding.btnSource.setOnClickListener{
        dataBinding.wvArticle.loadUrl("javascript:window.androidApi.printPageSource('<head>'+document.getElementsByTagName('html')[0].innerHTML+'</head>');")
    }

获取网页源代码后，通过比较网页源代码中的类名即可知道css中各个类名修饰的作用，接着结合自己所需要的主题编辑自己的主题css文件

拓展语言类型-以kotlin为例

syntaxhighlighter的基础资源中已经支持了很多语言类型，而最新的库版本时2016年发布的，所以没有kotlin很正常，当时我也不知到会踏入安卓的大门，哈哈，基础资源支持的语言类型如下：

打开一种语言的js文件可以发现其实就是简单编写配置：
1. 修改function Brush()下的keywords也就是该种语言的关键字
2. 修改function Brush()下的regexList，这个列表使是使用正则表达式取匹配注解、注释、变量等等，然后再与类名相关联，实现css对代码中的特殊字符的渲染
3. 修改Bursh.aliases：该属性的值是一个列表，要匹配代码类型的名称

交互优化

界面中只用WebView的时候，在代码块左右滑动是没有问题的，但是我们如果要做打赏列表、评论内容的时候，我们就得把WebView、RecyclerView放在NestedScrollView中，这样就会导致代码块左右滑动与NestedScrollView的上下滑动存在冲突，我的方案如下：

为代码块设置触摸的监听事件，可以在模板html中看到，代码如下：

    // 给代码块设置监听事件，当点击时通知给ktolin
        function onTouchStart(e) {
            androidApi.touchEvent(0);
        }

        function onTouchEnd(e) {
            androidApi.touchEvent(2);
        }

        function onTouchMove(e) {
        androidApi.touchEvent(1);
        }
        //
        function addTouchListener() {
            var dom = document.getElementsByClassName('code');
            androidApi.log(dom.length);
            for (i in dom){
                dom[i].addEventListener('touchstart', onTouchStart, false);
                dom[i].addEventListener('touchmove', onTouchMove, false);
                dom[i].addEventListener('touchend', onTouchEnd, false);
            }
        }

等待WebView加载完毕，调用js方法，为代码块添加监听事件

    //重写WebViewClient的子方法
    override fun onPageFinished(view: WebView?, url: String?) {
        super.onPageFinished(view, url)
        view?.loadUrl("javascript:addTouchListener()")
    }

通过回调的事件来分发触摸事件：

    //JsApi：接收js的回调
    @JavascriptInterface
    fun touchEvent(eventCode: Int) {
        Log.d(TAG, "touchEvent: $eventCode")
        when(eventCode){
            0 -> callback.invoke(EventCode.Event_DOWN)
            1 -> callback.invoke(EventCode.Event_MOVE)
            2 -> callback.invoke(EventCode.Event_UP)
        }
    }

    //重写WebView的子类：wbsv是重写的NestedScrollView,控制其是否可以滑动
    addJavascriptInterface(JsApi(){
        when(it){
            JsApi.EventCode.Event_UP->{
                wbsv?.setSlide(true)
            }
            JsApi.EventCode.Event_MOVE->{
                wbsv?.setSlide(slideDir)
            }
            JsApi.EventCode.Event_DOWN->{
                wbsv?.setSlide(slideDir )
            }
        }
    }, "androidApi") //AndroidtoJS类对象映射到js的test对象

    //重写WebView的子类：判断WebView的触摸事件，判断是否恢复NestedScrollView的滑动
    override fun onTouchEvent(event: MotionEvent?): Boolean {
        event?.let {
            val currentX =event.x
            val currentY = event.y
                when (event.action) {
                    MotionEvent.ACTION_DOWN -> {
                        startX = currentX
                        startY = currentY
                    }
                    MotionEvent.ACTION_MOVE -> {
                        slideDir = kotlin.math.abs(currentX - startX) <= kotlin.math.abs(currentY - startY)
                    }
                    MotionEvent.ACTION_UP -> {
                    }
                    else -> {
                    }
                }
        }
        return super.onTouchEvent(event)
    }

WebView中的链接处理

    /**
        * 重写WebViewClient的此方法，即可使WebView不再跳转
        */
    override fun shouldOverrideUrlLoading(view: WebView?, url: String?): Boolean {
        url?.let {
            callback.invoke(it)
        }
        return true
    }

通过上面的处理就可以解决代码块的滑动浏览问题了，到这里自定义样式、拓展语言类型、交互优化就结束了，这其中肯定还有待优化的地方，待以后结合实际使用体验慢慢进行优化处理。

拿来吧你

项目地址：https://github.com/coder-zt/SOBBlog
相关类：
相关资源：https://github.com/coder-zt/SOBBlog/tree/master/app/src/main/assets/syntaxhighlighter

只需要将上面几个类和JS库的相关资源搬到自己项目中然后使用ArticleWebView.loadArticle(content)即可实现对博客文章的渲染

总结

这篇文章刚好是我在这里发布的第10篇文章，由于中途去做了其他事，所以比预期发布时间晚了很多。这篇文章篇幅还是挺多的，但是可能还是有些地方还有待补充，欢迎同学们一起交流学习！

本文由 π大星原创发布于阳光沙滩，未经作者授权，禁止转载

0/240

断点-含光君

这个解释过程好麻烦啊，处理了很多常见问题，不过解析速度很快。文章的高亮的地方可定制性高。我使用的hl库是直接解析处理代码的，基本上没有主动操作代码高亮的份，代码的滑动这里我这边没有处理的，确实存在问题hh。

2021-08-13 18:45 回复
1139423796017500160
0/256
断点-含光君

先评论收藏打赏了再看文章

2021-08-13 18:14 回复
1139423796017500160
0/256
A lonely cat

TQL，nb！

2021-08-13 16:04 回复
1204736502274318336
0/256