https://github.com/zhyea/wordpress-client

WordPress Java client
https://github.com/zhyea/wordpress-client

wordpress-client wordpress-java wordpress-java-client wp-client

Last synced: 9 days ago
JSON representation

WordPress Java client

• Host: GitHub
• URL: https://github.com/zhyea/wordpress-client
• Owner: zhyea
• License: apache-2.0
• Created: 2018-12-19T11:01:57.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-10-05T02:59:47.000Z (about 2 years ago)
• Last Synced: 2023-07-28T17:24:36.474Z (over 1 year ago)
• Topics: wordpress-client, wordpress-java, wordpress-java-client, wp-client
• Language: Java
• Size: 59.6 KB
• Stars: 13
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 简介

WordPress Client是一个Java版的WordPress客户端操作库， 主要基于[WordPress XML-RPC API](https://codex.wordpress.org/XML-RPC_WordPress_API)实现。目前WordPress Client提供了如下能力：

* 获取WordPress用户信息

* 获取博客文章信息

* 发布文章到WordPress部署的博客

* 对已发布的文章进行编辑、删除等操作

# 使用

## 添加依赖

只需要在maven工程中的pom文件中添加如下依赖就可以使用wp-client：

```xml

        

            org.chobit.wp

            wordpress-client

            x.x.x

        

```

目前wp-client的版本是0.1.6。请尽量使用最新版本。

## 创建WordPress操作实例

WordPress实例是所有操作的基础。简单的WordPress实例创建方式如下：

```java

    WordPress wp = new WordPress(XML_RPC_URL, USERNAME, PASSWORD);

```

* xmlRpcUrl：xmlRpc服务端地址，WordPress博客的地址通常为**博客地址 + xmlrpc.php**，如：http://www.zhyea.com/xmlrpc.php

* username和password：登录WordPress博客后台使用的用户名和密码

也可以通过WPConfig（即WordPress配置对象）来更精细化地创建WordPress实例。WPConfig实例构建方式如下：

```java

        WPConfig config =

                        new WPConfigBuilder()

                                .username(USERNAME)

                                .password(PASSWORD)

                                .xmlRpcUrl(XML_RPC_URL)

                                .trustAll(true)

                                .connectTimeout(3 * 60 * 1000)

                                .readTimeout(3 * 60 * 1000)

                                .build();

```

不建议也不允许直接构建WPConfig实例，正确的方式是通过WPConfigBuilder来完成构建。构建中的几个参数如下：

* trustAll：如博客未启用https，可忽略；如已启用https，建议将之设置为true，否则需要导入证书文件后再进行操作；

* connectTimeout：连接超时时间，单位ms

* readTimeout：响应超时时间，单位ms

使用WPConfig实例来创建WordPress实例：

```java

        WordPress wp = new WordPress(config);

```

在WordPress类中封装了与WordPress进行交互的各种方法。接下来会逐个详细介绍下。

## 获取作者信息

在WordPress中提供了getUserBlogs和getAuthors两个方法来获取作者信息。

使用getUsersBlogs()方法可以获取非常简单的用户和博客信息：

```java

        List list = wp.getUsersBlogs();

```

返回值如下：

```json

[

    {

        "blogName": "ZY笔记",

        "url": "http://www.zhyea.com/",

        "admin": false,

        "blogid": 1,

        "xmlrpc": "http://www.zhyea.com/xmlrpc.php"

    }

]

```

(为了便于查看，故用json包装了下返回结果)

getAuthors()方法返回的是用户相关的信息：

```java

        List list = wp.getAuthors();

```

返回值如下：

```json

[

    {

        "user_id": 1,

        "user_login": "zhyea",

        "display_name": "白42"

    },

    {

        "user_id": 2,

        "user_login": "robin",

        "display_name": "robin"

    }

]

```

## 新增文章

新增文章可以使用newPost()方法，示例代码如下：  

```java

        PostRequest post = new PostRequest();

        post.setPostTitle("测试Title");

        post.setPostContent("这是一段测试文章内容");

        post.setCategories("分类1","分类2");

        post.setTags("a", "b", "c");

        post.setPostName("test-post-name");

        int postId = wp.newPost(post);

```

该方法的返回结果为postId，即文章ID。

* 关于postName和postTitle：postTitle指的是文章标题；postName指的则是文章别名，主要在文章的url路径中使用；通常建议将postName设置为英文字符。

* setCategories设置的是文章分类，如设置的分类在博客中不存在，将会按提交的分类名称创建新的分类。

* setTags设置的是文章标签，同样的，如标签在博客中不存在将会创建新的标签。

更多发布文章的参数可以参考[XML-RPC WordPress API/Posts - newPost](https://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.newPost)文档描述。

## 获取文章

获取文章有两个方法：getPosts和getPost。前者用于获取多篇文章，后者用于根据postId来获取文章。

### getPosts

getPosts方法如下：

```java

    List getPosts(PostFilter filter, String... fields)

```

参数filter决定返回结果的数量、排序字段和排序方式等信息。  

变长参数fields则决定了返回结果中包含哪些字段。如果要返回全部字段，可以不填。使用空字符串或其他非法字段则只返回postId。可用fields值请参考[XML-RPC WordPress API/Posts - getPost](https://codex.wordpress.org/XML-RPC_WordPress_API/Posts#Return_Values)。

示例代码如下：

```java

        PostFilter f = new PostFilter();

        f.setNumber(2);

        List list = wp.getPosts(f,"post_title");

```

返回结果为：

```json

[

    {

        "post_id": 2174,

        "post_title": "sbt下载加速方案"

    },

    {

        "post_id": 2170,

        "post_title": "Java 中文字符按Unicode排序"

    }

]

```

再次啰嗦下，正常的返回结果是一个Post实例集合，不是json字符串，这里使用json字符串只是为了便于展示。如需要获取json结果集可以自行将结果集转为json，也可以调用wp-client提供的JsonKit.toJson()方法进行处理。

### getPost

getPost方法如下：

```java

    Post getPost(int postId, String... fields) 

```

通过postId获取对应文章的信息。变长参数fields的使用请参考getPosts方法。

## 编辑文章

编辑文章调用editPost()方法。

```java

        PostRequest post = new PostRequest();

        post.setPostTitle("测试编辑" + System.currentTimeMillis());

        post.setPostContent("这是一段编辑后的测试内容：" + System.currentTimeMillis());

        boolean result = wp.editPost(29, post);

```

编辑文章时需要通过PostRequest实例完成。

注意，只需要为**要修改**的PostRequest属性赋值，不需修改的属性保留默认值即可。

## 删除文章

删除文章通过调用deletePost方法并传递postId来完成。

```java

        int postId = 26;

        boolean result = wp.deletePost(postId);

```

# 其他

wp-client目前只提供了一些WordPress的基础操作，并不能完全覆盖[WordPress XML-RPC API](https://codex.wordpress.org/XML-RPC_WordPress_API)提供的全部功能，需要在后续的时间内陆续完成。  

此外，因为一开始wp-client的开发只是为了自己使用，难免有些不足之处。如有想法还请抽时间[提个issue](https://github.com/zhyea/wordpress-client/issues)，或者在[我的博客](http://www.zhyea.com)上留言点出。