哔哩哔哩API - JavaSDK

本项目为社会易姐 QwQ(SocialSisterYi) 所收集整理的 Bilibili API 文档的 Java 封装。项目使用 OracleJDK1.8 开发，使用 Maven 编译和管理依赖。开始施工不久，还没有使用文档。如需了解 SDK 使用方法，请参考 Javadoc。

注：

1. 项目仅供研究学习使用，切勿滥用！

2. 本 SDK 并非官方软件，不保证长期稳定性和可用性。只提供不定期修补维护。

计划整理分类&目录：

使用方法

下载安装

# 创建临时文件夹
mkdir temp
cd temp

# 克隆相关代码
git clone https://github.com/Wonder2018/imwonder-util.git
git clone https://github.com/Wonder2018/bilibili-API-JavaSDK.git

# 编译安装
cd imwonder-util
mvn install
cd ../bilibili-API-JavaSDK
mvn install

在 pom.xml 中配置依赖

<!-- bilibili JavaSDK -->
<dependency>
    <groupId>top.imwonder.sdk.bilibili</groupId>
    <artifactId>bilibili-API-JavaSDK</artifactId>
    <version>1.0.0</version>
</dependency>

关于暂未完成封装的部分

目前通用接口请求方案已经成功制定，可以完成大部分的 json 数据请求。但由于实体封装工作量太大，还无法完整实现调用，如需使用还未完成封装的 API 可以自行建立消息实体并继承 top.imwonder.sdk.bilibili.domain.AbstractData 来实现简单迅速的封装，具体方法如下。（有意一起封装的可联系wonder2020获取本人常用联系方式并了解更多封装规范或直接提issue，也可直接提交 pr）

实体类编写注意事项：
1. 目前可以正常处理返回格式如下的 json：
```
{
    "code": 0,
    "message": "msg",
    "ttl": 1,
    "data": {}
}
```
2. 返回体根节点中可以有其他字段或缺少某些字段，但目前只处理以上四个字段，缺少的字段在实体中自动设为null。
3. 这里要求建立的实体是指 data 中的内容。
4. 自行建立的实体需要继承 top.imwonder.sdk.bilibili.domain.AbstractData以便统一管理。
5. 项目使用 Lombok 自动生成实体相关方法，实体类不需要自行建立getter和setter方法，只需在类的声明上加入@Data和@EqualsAndHashCode(callSuper = false)两个注解。
6. 实体中所有成员变量均需设为私有成员，并使用驼峰命名。若 json 返回体中的字段不是驼峰命名需在对应成员的声明上加@SerializedName("json_key")注解 "json_key" 替换为当前成员在 json 返回体中的字段名。
7. 涉及日期的实体如需将日期字符串转化为java.util.Date对象，须在类的声明上加@JsonAdapter(value = AbstractDataDateFormatConfig.class)注解，并在相应字段的声明上加@JsonDateFormat(pattern = "yyyy-MM-dd", timezone = "GMT+8")注解，并自行匹配日期格式，暂不支持时间戳转换。
8. top.imwonder.sdk.bilibili.domain.AbstractData 提供方法 public void copyFrom(AbstractData obj, boolean isCover),可将任何实体中的同名属性以浅拷贝的形式拷贝至当前实体。第二个参数可用于决定是否要覆盖本实体中的非null值。

请求 API 和实体的使用。

封装好实体后请求 API 的代码会非常简洁，下面将举例说明

// 此处只展示写法，具体方法的作用及参数和返回值意义可在IDE中将鼠标悬浮至方法名上，查看显示的Javadoc
URIBuilder uri = new URIBuilder(); // 构建URI
uri.setPath("https://www.example.com"); // 设置API地址
uri.setParameter("oauthKey", oauthKey); // 添加参数
HttpPost post = null; // 构建请求（注意对应API的请求方法）
try {
    post = new HttpPost(uri.build());
} catch (URISyntaxException e) {
    log.info(MessageUtil.getMsg("error.unexpected"));
    log.debug(MessageUtil.getMsg("error.debug.simple", e.getMessage()));
}
HttpRequestUtil.setComonHeader(post); // 插入通用请求头
Domain result = null; // 声明实体
try{
    result = HttpRequestUtil.loadInfo(post);
}catch(HttpRequestFailedException e){
    // 请求错误请检查参数配置或实体封装是否正确。
}

注：如果请求需要登陆的API，以上try语句块中请使用post = new HttpPost(user, uri.build());，其中user为成功登录的用户对象，登录方法可参考top.imwonder.sdk.bilibili.loginTest.QrCodeLoginTest，也可阅读登录相关代码的javadoc。

教程先写这么多了，之后慢慢补。（有意一起封装的可联系wonder2020获取本人常用联系方式并了解更多封装规范或直接提issue，也可直接提交 pr）

Powered with ❤ by Wonder2020

Name		Name	Last commit message	Last commit date
Latest commit History 8 Commits
src		src
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.travis.yml		.travis.yml
LICENSE		LICENSE
README.md		README.md
pom.xml		pom.xml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

哔哩哔哩API - JavaSDK

计划整理分类&目录：

使用方法

关于暂未完成封装的部分

相关项目

About

Releases

Packages

Languages

License

Wonder2018/bilibili-API-JavaSDK

Folders and files

Latest commit

History

Repository files navigation

哔哩哔哩API - JavaSDK

计划整理分类&目录：

使用方法

关于暂未完成封装的部分

相关项目

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages