mirror of
https://github.com/gedoor/legado.git
synced 2024-07-04 23:36:56 +08:00
[skip ci] doc: update jsHelp.md
This commit is contained in:
Xwite
parent
5126ec0cd2
commit
d38331b8bd
|
|
@ -1,17 +1,35 @@
|
|||
# js变量和函数
|
||||
> 阅读使用[Rhino](https://github.com/mozilla/rhino)作为JavaScript引擎以便于[调用Java类和方法](https://m.jb51.net/article/92138.htm)，查看[ECMAScript兼容性表格](https://mozilla.github.io/rhino/compat/engines.html)
|
||||
|
||||
书源规则中使用js可访问以下变量
|
||||
> java 变量-当前类
|
||||
> baseUrl 变量-当前url,String
|
||||
> result 变量-上一步的结果
|
||||
> book 变量-[书籍类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/Book.kt)
|
||||
> chapter 变量-[当前目录类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookChapter.kt)
|
||||
> source 变量-[基础书源类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BaseSource.kt)
|
||||
> cookie 变量-[cookie操作类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/help/http/CookieStore.kt)
|
||||
> cache 变量-[缓存操作类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/help/CacheManager.kt)
|
||||
> title 变量-当前标题,String
|
||||
> src 内容,源码
|
||||
> nextChapterUrl 变量 下一章节url
|
||||
> [Rhino运行时](https://github.com/mozilla/rhino/blob/master/src/org/mozilla/javascript/ScriptRuntime.java#L299)懒加载导入的Java类和方法
|
||||
|
||||
|构造函数|函数|对象|调用类|简要说明|
|
||||
|------|-----|------|----|------|
|
||||
|JavaImporter|ImportClass ImportPackage| |[ImporterTopLevel](https://github.com/mozilla/rhino/blob/master/src/org/mozilla/javascript/ImporterTopLevel.java#L147-L190)|导入Java类到JavaScript|
|
||||
||getClass|Packages java javax ...|[NativeJavaTopPackage](https://github.com/mozilla/rhino/blob/master/src/org/mozilla/javascript/NativeJavaTopPackage.java#L66-L104)|默认导入JavaScript中的Java类|
|
||||
|JavaAdapter|||[JavaAdapter](https://github.com/mozilla/rhino/blob/master/src/org/mozilla/javascript/JavaAdapter.java)|继承Java类|
|
||||
|
||||
> 注意`java`变量指向已经被阅读修改，如果想要调用`java.*`下的包，请使用`Packages.java.*`
|
||||
|
||||
> 在书源规则中使用`@js` `<js>` `{{}}`可使用JavaScript调用阅读部分内置的类和方法
|
||||
|
||||
> 注意为了安全，阅读会屏蔽部分java类调用，见[RhinoClassShutter](https://github.com/gedoor/legado/blob/master/modules/rhino/src/main/java/com/script/rhino/RhinoClassShutter.kt)
|
||||
|
||||
> 不同的书源规则中支持的调用的Java类和方法可能有所不同
|
||||
|
||||
|变量名|调用类|
|
||||
|------|-----|
|
||||
|java|当前类|
|
||||
|baseUrl|当前url,String |
|
||||
|result|上一步的结果|
|
||||
|book|[书籍类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/Book.kt)|
|
||||
|chapter|[章节类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookChapter.kt)|
|
||||
|source|[基础书源类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BaseSource.kt)|
|
||||
|cookie|[cookie操作类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/help/http/CookieStore.kt)|
|
||||
|cache|[缓存操作类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/help/CacheManager.kt)|
|
||||
|title|章节当前标题 String|
|
||||
|src| 请求返回的源码|
|
||||
|nextChapterUrl|下一章节url|
|
||||
|
||||
## 当前类对象的可使用的部分方法
|
||||
|
||||
|
|
@ -22,20 +40,19 @@
|
|||
|
||||
* 调用阅读搜索
|
||||
|
||||
```
|
||||
java.searchBook(
|
||||
bookName)
|
||||
```js
|
||||
java.searchBook(bookName: string)
|
||||
```
|
||||
|
||||
* 添加书架
|
||||
|
||||
```
|
||||
```js
|
||||
java.addBook(bookUrl)
|
||||
```
|
||||
|
||||
### [AnalyzeUrl](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/model/analyzeRule/AnalyzeUrl.kt) 部分函数
|
||||
> js中通过java.调用,只在`登录检查JS`规则中有效
|
||||
```
|
||||
```js
|
||||
initUrl() //重新解析url,可以用于登录检测js登录后重新解析url重新访问
|
||||
getHeaderMap().putAll(source.getHeaderMap(true)) //重新设置登录头
|
||||
getStrResponse( jsStr: String? = null, sourceRegex: String? = null) //返回访问结果,文本类型,书源内部重新登录后可调用此方法重新返回结果
|
||||
|
|
@ -46,13 +63,13 @@ getResponse(): Response //返回访问结果,网络朗读引擎采用的是这
|
|||
* 获取文本/文本列表
|
||||
> `mContent` 待解析源代码，默认为当前页面
|
||||
> `isUrl` 链接标识，默认为`false`
|
||||
```
|
||||
```js
|
||||
java.getString(ruleStr: String?, mContent: Any? = null, isUrl: Boolean = false)
|
||||
java.getStringList(ruleStr: String?, mContent: Any? = null, isUrl: Boolean = false)
|
||||
```
|
||||
* 设置解析内容
|
||||
|
||||
```
|
||||
```js
|
||||
java.setContent(content: Any?, baseUrl: String? = null):
|
||||
```
|
||||
|
||||
|
|
@ -60,7 +77,7 @@ java.setContent(content: Any?, baseUrl: String? = null):
|
|||
|
||||
> 如果要改变解析源代码，请先使用`java.setContent`
|
||||
|
||||
```
|
||||
```js
|
||||
java.getElement(ruleStr: String)
|
||||
java.getElements(ruleStr: String)
|
||||
```
|
||||
|
|
@ -69,13 +86,13 @@ java.getElements(ruleStr: String)
|
|||
|
||||
> 可以在刷新目录之前使用,有些书源书籍地址和目录url会变
|
||||
|
||||
```
|
||||
```js
|
||||
java.reGetBook()
|
||||
java.refreshTocUrl()
|
||||
```
|
||||
* 变量存取
|
||||
|
||||
```
|
||||
```js
|
||||
java.get(key)
|
||||
java.put(key, value)
|
||||
```
|
||||
|
|
@ -83,14 +100,16 @@ java.put(key, value)
|
|||
### [js扩展类](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/help/JsExtensions.kt) 部分函数
|
||||
|
||||
* 链接解析[JsURL](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/utils/JsURL.kt)
|
||||
|
||||
```
|
||||
```js
|
||||
java.toURL(url): JsURL
|
||||
java.toURL(url, baseUrl): JsURL
|
||||
```
|
||||
* 网络请求
|
||||
|
||||
* 获取SystemWebView User-Agent
|
||||
```js
|
||||
java.getWebViewUA(): String
|
||||
```
|
||||
* 网络请求
|
||||
```js
|
||||
java.ajax(urlStr): String
|
||||
java.ajaxAll(urlList: Array<String>): Array<StrResponse?>
|
||||
//返回Response 方法body() code() message() header() raw() toString()
|
||||
|
|
@ -124,28 +143,28 @@ java.startBrowser(url: String, title: String)
|
|||
java.startBrowserAwait(url: String, title: String): StrResponse
|
||||
```
|
||||
* 调试
|
||||
```
|
||||
```js
|
||||
java.log(msg)
|
||||
java.logType(var)
|
||||
```
|
||||
* 获取用户输入的验证码
|
||||
```
|
||||
```js
|
||||
java.getVerificationCode(imageUrl)
|
||||
```
|
||||
* 弹窗提示
|
||||
```
|
||||
```js
|
||||
java.longToast(msg: Any?)
|
||||
java.toast(msg: Any?)
|
||||
```
|
||||
* 从网络(由java.cacheFile实现)、本地读取JavaScript文件，导入上下文请手动`eval(String(...))`
|
||||
```
|
||||
```js
|
||||
java.importScript(url)
|
||||
//相对路径支持android/data/{package}/cache
|
||||
java.importScript(relativePath)
|
||||
java.importScript(absolutePath)
|
||||
```
|
||||
* 缓存网络文件
|
||||
```
|
||||
```js
|
||||
获取
|
||||
java.cacheFile(url)
|
||||
java.cacheFile(url,saveTime)
|
||||
|
|
@ -155,7 +174,7 @@ eval(String(java.cacheFile(url)))
|
|||
cache.delete(java.md5Encode16(url))
|
||||
```
|
||||
* 获取网络压缩文件里面指定路径的数据 *可替换Zip Rar 7Z
|
||||
```
|
||||
```js
|
||||
java.get*StringContent(url: String, path: String): String
|
||||
|
||||
java.get*StringContent(url: String, path: String, charsetName: String): String
|
||||
|
|
@ -165,14 +184,14 @@ java.get*ByteArrayContent(url: String, path: String): ByteArray?
|
|||
```
|
||||
* base64
|
||||
> flags参数可省略，默认Base64.NO_WRAP，查看[flags参数说明](https://blog.csdn.net/zcmain/article/details/97051870)
|
||||
```
|
||||
```js
|
||||
java.base64Decode(str: String)
|
||||
java.base64Decode(str: String, charset: String)
|
||||
java.base64DecodeToByteArray(str: String, flags: Int)
|
||||
java.base64Encode(str: String, flags: Int)
|
||||
```
|
||||
* ByteArray
|
||||
```
|
||||
```js
|
||||
Str转Bytes
|
||||
java.strToBytes(str: String)
|
||||
java.strToBytes(str: String, charset: String)
|
||||
|
|
@ -181,7 +200,7 @@ java.bytesToStr(bytes: ByteArray)
|
|||
java.bytesToStr(bytes: ByteArray, charset: String)
|
||||
```
|
||||
* Hex
|
||||
```
|
||||
```js
|
||||
HexString 解码为字节数组
|
||||
java.hexDecodeToByteArray(hex: String)
|
||||
hexString 解码为utf8String
|
||||
|
|
@ -190,20 +209,24 @@ utf8 编码为hexString
|
|||
java.hexEncodeToString(utf8: String)
|
||||
```
|
||||
* 标识id
|
||||
```
|
||||
```js
|
||||
java.randomUUID()
|
||||
java.androidId()
|
||||
```
|
||||
* 繁简转换
|
||||
```
|
||||
```js
|
||||
将文本转换为简体
|
||||
java.t2s(text: String): String
|
||||
将文本转换为繁体
|
||||
java.s2t(text: String): String
|
||||
```
|
||||
* 时间格式化
|
||||
```js
|
||||
java.timeFormatUTC(time: Long, format: String, sh: Int): String?
|
||||
```
|
||||
* 文件
|
||||
> 所有对于文件的读写删操作都是相对路径,只能操作阅读缓存/android/data/{package}/cache/内的文件
|
||||
```
|
||||
```js
|
||||
//文件下载 url用于生成文件名，返回文件路径
|
||||
downloadFile(url: String): String
|
||||
//文件解压,zipPath为压缩文件路径，返回解压路径
|
||||
|
|
@ -224,19 +247,15 @@ deleteFile(path: String)
|
|||
> 提供在JavaScript环境中快捷调用crypto算法的函数，由[hutool-crypto](https://www.hutool.cn/docs/#/crypto/概述)实现
|
||||
> 由于兼容性问题，hutool-crypto当前版本为5.8.22
|
||||
|
||||
> 其他没有添加的算法可在JavaScript中使用`JavaImporter`[调用](https://m.jb51.net/article/92138.htm)Java，例子可参考`朗读引擎-阿里云语音`
|
||||
|
||||
> 注意阅读app会屏蔽部分java类调用，见[RhinoClassShutter](https://github.com/gedoor/legado/blob/master/modules/rhino/src/main/java/com/script/rhino/RhinoClassShutter.kt)
|
||||
|
||||
> 注意：如果输入的参数不是Utf8String 可先调用`java.hexDecodeToByteArray java.base64DecodeToByteArray`转成ByteArray
|
||||
* 对称加密
|
||||
> 输入参数key iv 支持ByteArray|**Utf8String**
|
||||
```
|
||||
```js
|
||||
// 创建Cipher
|
||||
java.createSymmetricCrypto(transformation, key, iv)
|
||||
```
|
||||
>解密加密参数 data支持ByteArray|Base64String|HexString|InputStream
|
||||
```
|
||||
```js
|
||||
//解密为ByteArray String
|
||||
cipher.decrypt(data)
|
||||
cipher.decryptStr(data)
|
||||
|
|
@ -247,7 +266,7 @@ cipher.encryptHex(data)
|
|||
```
|
||||
* 非对称加密
|
||||
> 输入参数 key支持ByteArray|**Utf8String**
|
||||
```
|
||||
```js
|
||||
//创建cipher
|
||||
java.createAsymmetricCrypto(transformation)
|
||||
//设置密钥
|
||||
|
|
@ -256,7 +275,7 @@ java.createAsymmetricCrypto(transformation)
|
|||
|
||||
```
|
||||
> 解密加密参数 data支持ByteArray|Base64String|HexString|InputStream
|
||||
```
|
||||
```js
|
||||
//解密为ByteArray String
|
||||
cipher.decrypt(data, usePublicKey: Boolean? = true
|
||||
)
|
||||
|
|
@ -272,7 +291,7 @@ cipher.encryptHex(data, usePublicKey: Boolean? = true
|
|||
```
|
||||
* 签名
|
||||
> 输入参数 key 支持ByteArray|**Utf8String**
|
||||
```
|
||||
```js
|
||||
//创建Sign
|
||||
java.createSign(algorithm)
|
||||
//设置密钥
|
||||
|
|
@ -280,24 +299,24 @@ java.createSign(algorithm)
|
|||
.setPrivateKey(key)
|
||||
```
|
||||
> 签名参数 data支持ByteArray|inputStream|String
|
||||
```
|
||||
```js
|
||||
//签名输出 ByteArray HexString
|
||||
sign.sign(data)
|
||||
sign.signHex(data)
|
||||
```
|
||||
* 摘要
|
||||
```
|
||||
```js
|
||||
java.digestHex(data: String, algorithm: String,): String?
|
||||
|
||||
java.digestBase64Str(data: String, algorithm: String,): String?
|
||||
```
|
||||
* md5
|
||||
```
|
||||
```js
|
||||
java.md5Encode(str)
|
||||
java.md5Encode16(str)
|
||||
```
|
||||
* HMac
|
||||
```
|
||||
```js
|
||||
java.HMacHex(data: String, algorithm: String, key: String): String
|
||||
|
||||
java.HMacBase64(data: String, algorithm: String, key: String): String
|
||||
|
|
@ -306,7 +325,7 @@ java.HMacBase64(data: String, algorithm: String, key: String): String
|
|||
## book对象的可用属性
|
||||
### 属性
|
||||
> 使用方法: 在js中或{{}}中使用book.属性的方式即可获取.如在正文内容后加上 ##{{book.name+"正文卷"+title}} 可以净化 书名+正文卷+章节名称（如 我是大明星正文卷第二章我爸是豪门总裁） 这一类的字符.
|
||||
```
|
||||
```js
|
||||
bookUrl // 详情页Url(本地书源存储完整文件路径)
|
||||
tocUrl // 目录页Url (toc=table of Contents)
|
||||
origin // 书源URL(默认BookType.local)
|
||||
|
|
@ -339,7 +358,7 @@ variable // 自定义书籍变量信息(用于书源规则检索书籍信息)
|
|||
|
||||
## chapter对象的部分可用属性
|
||||
> 使用方法: 在js中或{{}}中使用chapter.属性的方式即可获取.如在正文内容后加上 ##{{chapter.title+chapter.index}} 可以净化 章节标题+序号(如 第二章 天仙下凡2) 这一类的字符.
|
||||
```
|
||||
```js
|
||||
url // 章节地址
|
||||
title // 章节标题
|
||||
baseUrl //用来拼接相对url
|
||||
|
|
@ -354,17 +373,17 @@ variable // 自定义书籍变量信息(用于书源规则检索书籍信息)
|
|||
|
||||
## source对象的部分可用函数
|
||||
* 获取书源url
|
||||
```
|
||||
```js
|
||||
source.getKey()
|
||||
```
|
||||
* 书源变量存取
|
||||
```
|
||||
```js
|
||||
source.setVariable(variable: String?)
|
||||
source.getVariable()
|
||||
```
|
||||
|
||||
* 登录头操作
|
||||
```
|
||||
```js
|
||||
source.getLoginHeader()
|
||||
source.getLoginHeaderMap().get(key: String)
|
||||
source.putLoginHeader(header: String)
|
||||
|
|
@ -372,13 +391,13 @@ source.removeLoginHeader()
|
|||
```
|
||||
* 用户登录信息操作
|
||||
> 使用`登录UI`规则，并成功登录，阅读自动加密保存登录UI规则中除type为button的信息
|
||||
```
|
||||
```js
|
||||
source.getLoginInfo()
|
||||
source.getLoginInfoMap().get(key: String)
|
||||
source.removeLoginInfo()
|
||||
```
|
||||
## cookie对象的部分可用函数
|
||||
```
|
||||
```js
|
||||
获取全部cookie
|
||||
cookie.getCookie(url)
|
||||
获取cookie某一键值
|
||||
|
|
@ -390,7 +409,7 @@ cookie.removeCookie(url)
|
|||
## cache对象的部分可用函数
|
||||
> saveTime单位:秒，可省略
|
||||
> 保存至数据库和缓存文件(50M)，保存的内容较大时请使用`getFile putFile`
|
||||
```
|
||||
```js
|
||||
保存
|
||||
cache.put(key: String, value: Any , saveTime: Int)
|
||||
读取数据库
|
||||
|
|
@ -406,4 +425,4 @@ cache.deleteMemory(key: String)
|
|||
cache.getFromMemory(key: String): Any?
|
||||
cache.putMemory(key: String, value: Any)
|
||||
|
||||
```
|
||||
```
|
||||
Loading…
Reference in New Issue
Block a user