插件示例

Bangumi API在新窗口打开为例开发一个纯纯看番插件项目,由于纯纯看番的插件系统比较灵活,这里仅通过Bangumi API实现番剧的更新日历、查找、信息展示。

在一切开始之前,建议使用自己构建的纯纯看番,这样就可以在Android Studio中对本体和插件进行调试。

注意

这篇教程并不涉及番剧的解析、播放等操作

本示例代码已开源: easybangumiorg/Extension-example-bangumiapi在新窗口打开

初始化项目

修改 Package Name

打开Android Studio创建一个空白项目(No Activity)

提示

名称(Name)和包名(Package Name)可以任取,但是请尽量不要使用默认。

这里的包名使用的是org.easybangumi.extension.zh.bangumiapi

create-extension-settings

等待Gradle Sync的完成,如果Gradle Sync没有正常开始,请手动进行。

采用默认的Android视图,这是项目结构:

create-path

修改 settings.gradle.kts

打开settings.gradle.kts文件,在dependencyResolutionManagement中添加snapshot源。

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/") }
        maven { url = uri("https://jitpack.io") }
    }
}





 
 


修改 gradle.build.kts

打开gradle.build.kts文件,后面带有Module :app的那个,在dependencies中添加插件化库,然后执行Gradle Sync。

dependencies {
    compileOnly("io.github.easybangumiorg:extension-api:1.2-SNAPSHOT")

    implementation("androidx.core:core-ktx:1.9.0")
    implementation("androidx.appcompat:appcompat:1.6.1")
    implementation("com.google.android.material:material:1.8.0")
    testImplementation("junit:junit:4.13.2")
    androidTestImplementation("androidx.test.ext:junit:1.1.5")
    androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
}

 








提示

一般情况下,仅需要添加以上第二行代码即可,其余的依赖如果不需要使用可以删除

注意

在本例程中,假如删除了其他依赖项,你需要把两个Test(AndroidTest和Test)和res下的xml与values也删除

修改 AndroidManifest.xml

在这一步开始之前,请务必确保已经执行了Gradle Sync。

打开AndroidManifest.xml,修改整个文件,以下给出一个文件示例,高亮的行是需要根据实际情况修改的。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <uses-feature android:name="easybangumi.extension" android:required="true" />
    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="EasyBangumi: 番组计划API"
        android:supportsRtl="true">
        <!--readme-->
        <meta-data
            android:name="easybangumi.extension.readme"
            android:value="纯纯看番扩展,番组计划" />
        <!--libVersion-->
        <meta-data
            android:name="easybangumi.extension.lib.version"
            android:value="1" />
        <!--source-->
        <meta-data
            android:name="easybangumi.extension.source"
            android:value="org.easybangumi.extension.zh.bangumiapi.Factory"/>
        <!--为了让本体能找到需要加-->
        <activity android:name="com.heyanle.extension_api.NoneActivity"
            android:exported="true">
            <intent-filter>
                <action android:name="android.intent.action.ANSWER" />
                <data android:host="com.heyanle.easybangumi"
                    android:scheme="source"/>
            </intent-filter>
        </activity>
    </application>
    <queries>
        <package android:name="com.heyanle.easybangumi" />
    </queries>
</manifest>





 
 




 







 














第六行设置的是插件的应用图标,这里采用默认的应用图片,实际使用中应该自己指定一张图标。第七行设置的是插件的应用名称,推荐以EasyBangumi:开头方便用户进行搜索。这两行设置的内容对应你在应用管理中看到的部分。

第十二行设置的是插件在纯纯看番内显示的摘要信息,目前没有使用但不推荐随意设置。

第二十行设置的是插件的入口点,这里设置的入口点是org.easybangumi.extension.zh.bangumiapi.Factory,于是之后需要在对应的这个位置创建入口类Factory

插件化框架

插件图标

下载番组计划的LOGO,将LOGO文件移动到drawable下,如果希望应用程序的LOGO也是自定义的话可以修改AndroidManifest.xml

假如logo文件是icon.png,那么就将第六行修改为@drawable/icon

注意

如果使用JPEG图片的话可能会导致一些不可意料的问题,推荐使用的图片格式有PNG和WebP。

创建番剧源类 BangumiApiSource

org.easybangumi.extension.zh.bangumiapi的主文件夹下创建一个名为BangumiApiSource的类,以下给出一个模板写法。

package org.easybangumi.extension.zh.bangumiapi

import com.heyanle.bangumi_source_api.api.component.Component
import com.heyanle.extension_api.ExtensionIconSource
import com.heyanle.extension_api.ExtensionSource

class BangumiApiSource : ExtensionSource(), ExtensionIconSource  {
    override fun getIconResourcesId(): Int {
        return R.drawable.icon
    }

    override val describe: String?
        get() = null
    override val label: String
        get() = "番组计划"
    override val version: String
        get() = "1.0"
    override val versionCode: Int
        get() = 1
    override val sourceKey: String
        get() = "bangumiapi"

    override fun components(): List<Component> {
        return listOf(

        )
    }
}

R.drawable.icon插件图标定义的插件LOGO。

之前所有的内容都是定义插件本身的,从这一步开始定义这个插件中唯一的番剧源BangumiApiSource及其五个属性:

  • describe定义的是番剧源的描述,不是必填项目
  • label定义的是番剧源在纯纯看番中显示的名称
  • version定义的是番剧源在纯纯看番中显示的版本号
  • versionCode定义的是番剧源的版本代码,推荐的做法是从1开始每个版本加一
  • sourceKey定义的是番剧源数据在纯纯看番本地数据库中使用的hash因素,应该是每个番剧源唯一的

注意

sourceKey非常重要,假如你修改了这个值将会导致用户之前追的番剧无法找到对应的番剧源更新,一个合理的建议是使用小写英文字母以及下划线和减号来构成sourceKey

最后的components()函数返回了这个番源所有支持的功能模块,此时并没有编写任何的模块,返回一个空列表。

创建插件入口点 SourceFactory

org.easybangumi.extension.zh.bangumiapi的主文件夹下创建一个名为Factory的类,在类中引入com.heyanle.bangumi_source_api.api.SourceFactory,让创建的Factory类实现SourceFactory

以下是一个基本示例:

package org.easybangumi.extension.zh.bangumiapi

import com.heyanle.bangumi_source_api.api.SourceFactory

class Factory: SourceFactory {
    override fun create() = listOf(BangumiApiSource())
}

create函数返回的是源的实例列表,如果你希望在一个插件内添加多个番剧源,可以修改这里的返回结果。

在做完这一步后,你可以尝试编译整个项目并且在你的安卓设备上运行,如果一切都设置正确,那么在纯纯看番软件内就可以看到你编写的插件了,但是在这时编写的插件并没有实现功能,还需要接下来的教程。

基本功能

纯纯看番一共有五种基本的组件,通过实现ComponentWrapper类进行加载,实现Component来访问番剧源类。

至少需要PageComponent、SearchComponent和DetailedComponent来实现一个番剧源的基本功能。

创建工具类

在开始之前需要创建一个工具类,将常用的参数、网络访问和Json解析都打包到一起,来使得编写更加流畅。

提示

在引入插件化库后可以直接使用gsonokhttp3

package org.easybangumi.extension.zh.bangumiapi

import com.google.gson.JsonElement
import com.google.gson.JsonNull
import com.google.gson.JsonParser
import com.heyanle.lib_anim.utils.SourceUtils
import com.heyanle.lib_anim.utils.network.GET
import com.heyanle.lib_anim.utils.network.networkHelper
import okhttp3.Headers

var ROOT_URL = "https://api.bgm.tv"

fun getJson(target: String): Result<JsonElement> {
    return runCatching {
        val req = networkHelper.client.newCall(
            GET(url(target),
                Headers.Builder()
                    .add("User-Agent","EasyBangumi/4.1.0 (Android;API 1;lib 1.2-SNAPSHOT) EasyBangumi/bangumiapi/1.0 (Android;Extension)")
                    .build()
            )
        ).execute()
        val body = req.body!!.string()
        JsonParser.parseString(body)
    }
}

fun url(source: String): String {
    return SourceUtils.urlParser(ROOT_URL, source)
}

operator fun JsonElement.get(index: Int): JsonElement {
    return this.asJsonArray[index]!!
}

operator fun JsonElement.get(key: String): JsonElement {
    return this.asJsonObject[key]!!
}

创建页面组件 PageComponent

番剧源的浏览一般从页面开始,纯纯看番在页面组件中提供两层页面层级,分别是页面组和页面,页面组可以包含多个页面,而页面也有两种,带封面的番剧页面和不带番剧封面的页面,两种页面均支持异步加载。

在PageComponent中,需要实现getPages函数,可以返回页面组或页面组成的列表,而页面组和页面都支持返回一个异步,当页面或页面组打开的时候执行

以下是一个页面组件的基本结构

package org.easybangumi.extension.zh.bangumiapi

import com.heyanle.bangumi_source_api.api.component.ComponentWrapper
import com.heyanle.bangumi_source_api.api.component.page.PageComponent
import com.heyanle.bangumi_source_api.api.component.page.SourcePage

class BangumiApiPageComponent(source: BangumiApiSource): ComponentWrapper(source), PageComponent {
    override fun getPages(): List<SourcePage> {
        return  listOf(
            // 页面组或是页面
        )
    }

    // 功能函数
}

紧接着在BangumiApiSource中启用这个组件

// 以上省略
    override fun components(): List<Component> {
        return listOf(
            BangumiApiPageComponent(this),
        )
    }
}



 



简单写一些代码实现功能

package org.easybangumi.extension.zh.bangumiapi

import com.heyanle.bangumi_source_api.api.component.ComponentWrapper
import com.heyanle.bangumi_source_api.api.component.page.PageComponent
import com.heyanle.bangumi_source_api.api.component.page.SourcePage
import com.heyanle.bangumi_source_api.api.entity.CartoonCover
import com.heyanle.bangumi_source_api.api.entity.CartoonCoverImpl
import com.heyanle.bangumi_source_api.api.withResult
import kotlinx.coroutines.Dispatchers

class BangumiApiPageComponent(source: BangumiApiSource): ComponentWrapper(source), PageComponent {
    override fun getPages(): List<SourcePage> {
        return  listOf(
            // 新番时刻表
            SourcePage.Group(
                "每日更新列表",
                false,
            ) {
                withResult(Dispatchers.IO) {
                    CalendarGroup()
                }
            },
        )
    }

    // 功能函数
    fun CalendarGroup(): List<SourcePage.SingleCartoonPage> {
        val group = arrayListOf<SourcePage.SingleCartoonPage>()
        val doc = getJson("/calendar").getOrElse { throw it }
        doc.asJsonArray.forEach{
            val items = arrayListOf<CartoonCover>()
            it["items"].asJsonArray.forEach{item ->
                println(item.toString())
                val nameCN = item["name_cn"].asString

                items.add(CartoonCoverImpl(
                    id = item["id"].asString,
                    source = this.source.key,
                    url = item["url"].asString,
                    title = if (nameCN.isEmpty()) item["name"].asString else nameCN,
                    intro = item["summary"].asString,
                    coverUrl = if (item["images"].isJsonNull) "" else item["images"]["common"].asString,
                ))
            }
            group.add(SourcePage.SingleCartoonPage.WithCover(
                label = it["weekday"]["cn"].asString,
                firstKey = {1},
            ) {
                withResult(Dispatchers.IO) {
                    null to items
                }
            })

        }
        return group
    }
}





 
 
 
 




 
 
 
 
 
 
 
 
 




 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

效果展示

bangumiapi-calendar-success

创建详细信息组件 DetailedComponent

详细信息组件负责番剧卡片点进二级页面的内容,具体是以下的内容:

get-detailed

分别是番剧标题、标签、封面图、描述信息和播放列表,由于BangumiAPI不提供播放播放服务,播放列表一律返回空,在实际情况中还应该区分播放线路使用。

以下是一个详细信息组件的模板,这份模板将专注实现番剧信息的获取而忽略播放列表

package org.easybangumi.extension.zh.bangumiapi

import com.heyanle.bangumi_source_api.api.SourceResult
import com.heyanle.bangumi_source_api.api.component.ComponentWrapper
import com.heyanle.bangumi_source_api.api.component.detailed.DetailedComponent
import com.heyanle.bangumi_source_api.api.entity.Cartoon
import com.heyanle.bangumi_source_api.api.entity.CartoonImpl
import com.heyanle.bangumi_source_api.api.entity.CartoonSummary
import com.heyanle.bangumi_source_api.api.entity.PlayLine
import com.heyanle.bangumi_source_api.api.withResult
import kotlinx.coroutines.Dispatchers

class BangumiApiDetailedComponent(source: BangumiApiSource) : ComponentWrapper(source), DetailedComponent {

    override suspend fun getAll(summary: CartoonSummary): SourceResult<Pair<Cartoon, List<PlayLine>>> {
        return withResult(Dispatchers.IO) {
            getDetailByID(summary.id) to arrayListOf()
        }
    }

    override suspend fun getDetailed(summary: CartoonSummary): SourceResult<Cartoon> {
        return withResult(Dispatchers.IO) {
            getDetailByID(summary.id)
        }
    }

    override suspend fun getPlayLine(summary: CartoonSummary): SourceResult<List<PlayLine>> {
        return withResult(Dispatchers.IO) {
            arrayListOf()
        }
    }

    suspend fun getDetailByID(id: String): Cartoon {
        TODO("Not yet implemented")
    }
}

接下来实现getDetailByID函数

private fun getDetailByID(id: String): Cartoon {
    val doc = getJson("/v0/subjects/$id").getOrElse { throw it }

    val nameCN = doc["name_cn"].asString
    val score = doc["rating"]["score"].asString

    val tags = arrayListOf<String>()
    doc["tags"].asJsonArray.forEachIndexed { i, it ->
        if (i > 10) return@forEachIndexed
        tags.add(it["name"].asString)
    }

    return CartoonImpl(
        id = id,
        url = "http://bgm.tv/subject/$id",
        source = this.source.key,

        title = nameCN.ifEmpty { doc["name"].asString },
        coverUrl = if (doc["images"].isJsonNull) "" else doc["images"]["common"].asString,

        intro = "bgm "+if (score.equals("0")) "未评分" else score,
        description = doc["summary"].asString,

        genre = tags.joinToString(","),

        status = Cartoon.STATUS_UNKNOWN,
        updateStrategy = Cartoon.UPDATE_STRATEGY_NEVER
    )
}

于是就可以获取番剧的详情信息了(尽管不能播放)

get-detail-self

创建搜索组件 SearchComponent

需要提供搜索功能来查找指定番剧,这里直接给出完整代码

package org.easybangumi.extension.zh.bangumiapi

import com.heyanle.bangumi_source_api.api.SourceResult
import com.heyanle.bangumi_source_api.api.component.ComponentWrapper
import com.heyanle.bangumi_source_api.api.component.search.SearchComponent
import com.heyanle.bangumi_source_api.api.entity.CartoonCover
import com.heyanle.bangumi_source_api.api.entity.CartoonCoverImpl
import com.heyanle.bangumi_source_api.api.withResult
import kotlinx.coroutines.Dispatchers

class BangumiApiSearchComponent(source: BangumiApiSource) : ComponentWrapper(source), SearchComponent {
    override fun getFirstSearchKey(keyword: String): Int {
        return 0
    }

    override suspend fun search(
        pageKey: Int,
        keyword: String
    ): SourceResult<Pair<Int?, List<CartoonCover>>> {
        return withResult(Dispatchers.IO) {
            val doc = getJson("/search/subject/$keyword?type=2&responseGroup=small&max_results=20&start=$pageKey")
                .getOrElse { throw it }
            val next = if (doc["results"].asInt > pageKey+20) pageKey+20 else null
            val list = arrayListOf<CartoonCover>()

            doc["list"].asJsonArray.forEach{
                val nameCN = it["name_cn"].asString

                list.add(
                    CartoonCoverImpl(
                        id = it["id"].asString,
                        source = this.source.key,
                        url = it["url"].asString,
                        title = nameCN.ifEmpty { it["name"].asString },
                        intro = "",
                        coverUrl = if (it["images"].isJsonNull) "" else it["images"]["common"].asString,
                    )
                )
            }

            return@withResult next to list
        }
    }
}

效果展示

search