开发主题，首先要会使用freemarker模板引擎

必要说明：

• 主题开发好了，需要放在 src/main/resources/templates/theme 下，系统启动会自动读取主题目录，然后在后台就可以选择你想要的主题了
• 如果你不是开发环境，那需要将开发好的或者下载的主题文件夹放在 pybbs.jar 所在目录下的 templates/theme 文件夹下，如果这两个文件夹没有，需要你创建好
• 开发主题肯定需要引入样式，建议使用 cdnjs.com 的外链，但也有一些对系统内的样式，这个样式文件需要放在 pybbs.jar 目录所在文件夹下的 templates/static/theme/css 文件夹下，js同理

主题目录

主题必备目录有以下几个

simple
├── comment
├── tag
├── topic
└── user

必备的文件有如下

simple
├── comment
│   └── edit.ftl
├── error.ftl
├── index.ftl
├── login.ftl
├── notifications.ftl
├── register.ftl
├── search.ftl
├── tag
│   ├── tag.ftl
│   └── tags.ftl
├── top100.ftl
├── topic
│   ├── create.ftl
│   ├── detail.ftl
│   └── edit.ftl
└── user
    ├── collects.ftl
    ├── comments.ftl
    ├── profile.ftl
    ├── settings.ftl
    └── topics.ftl

注意，上面列出来的文件夹和文件都是必备的

如果你习惯封装，可以跟default主题里一样，把通用的代码块封装成component，放在一个文件夹里（比如 default主题里的组件文件夹就是 components 当然这个不是必须的）

全局对象

通俗点说就是在所有页面里都能取到的数据的对象，有如下几个

model对象内的方法

String formatDate(Date date);
String formatContent(String content);
Set<String> getUpIds(String upIds);
boolean isEmpty(String txt);

site对象中的属性

在页面里取site里的属性方法 ${site.name!}

属性的类型全都是 String，可根据自己需要将值转成 int 或者 boolean

i18n对象中的属性

在页面中获取的方法是 ${i18n.getMessage("index")}

Freemarker自定义标签

pybbs提供了如下几个自定义标签

在标签返回对象里有一些不是定义的model里的对象，而是Map封装的对象，这些map里都有啥呢？

标签 tag_topics 对象中的Map包含的字段

• Topic t.*: Topic对象里的所有字段
• username: 用户名
• avatar: 用户头像

标签 tag_notifications 对象中的Map包含的字段

• Notification n.*: Notification对象里的所有字段
• username: 用户名
• avatar: 用户头像
• title: 话题标题
• topicId: 话题ID

标签 tag_search 对象中的Map包含的字段

• id: 话题ID
• title: 话题标题
• content: 话题内容

标签 tag_user_topics 对象中的Map包含的字段

• Topic t.*: Topic对象里的所有字段
• username: 用户名
• avatar: 用户头像

标签 tag_user_comments 对象中的Map包含的字段

• Comment c.*: Comment对象里的所有字段
• topicUsername: 话题的用户名
• commentUsername: 话题的用户名
• title: 话题标题
• topicId: 话题ID

标签 tag_user_collects 对象中的Map包含的字段

• Topic t.*: Topic对象里的所有字段
• username: 用户名
• avatar: 用户头像

自定义标签使用

自定义标签用法很简单，不会用的话，可以参考已经存在的主题里的用法，下面说一下首页的 tag_topics 标签的用法

<@tag_topics pageNo=pageNo tab=tab>
  // tag_topics 里的两个参数都是从controller里传过来的
  // 在标签内部就可以拿到自定义标签返回的对象了，比如这个标签返回的就一个page对象
  <#list page.records as topic>
    <p>${topic.title}</p>
  </#list>
</@tag_topics>

至于标签里返回的对象都是什么东西，下面介绍，先说说每个路由渲染的页面里都能取出什么东西吧

路由渲染可获取对象

对象包含的字段

分页对象 Page

这个对象是Mybatis-Plus里封装的，常用字段有以下几个

• List records: 查询出来的列表放在这个里面，类型是个List
• long current: 当前是第几页，从1开始
• long total: 总条数
• long pages: 总页数
• long size: 每页显示条数

用户对象 User

private Integer id;
private String username;
private String telegramName;
private String avatar;
private String password;
private String email;
// 个人网站
private String website;
// 个人简介
private String bio;
private Integer score;
private Date inTime;
private String token;
// 有消息通知是否通过邮箱收取
private Boolean emailNotification;
// 帐号的激活状态
private Boolean active;

话题对象 Topic

private Integer id;
private String title;
private String content;
private Date inTime;
private Date modifyTime;
private Integer userId;
// 评论数
private Integer commentCount;
// 收藏数
private Integer collectCount;
// 浏览数
private Integer view;
// 置顶
private Boolean top;
// 加精
private Boolean good;
// 点赞用户的id英文,隔开的，要计算被多少人点赞过，可以通过英文,分隔这个字符串计算数量
private String upIds;

评论对象 Comment

private Integer id;
private Integer topicId;
private Integer userId;
private String content;
private Date inTime;
private Integer commentId;
// 点赞用户的id
private String upIds;

评论(盖楼)对象 CommentsByTopic

// 话题下面的评论列表单个对象的数据结构
public class CommentsByTopic extends Comment implements Serializable {
  private String username;
  private String avatar;
  // 评论的层级，直接评论话题的，layer即为0，如果回复了评论的，则当前回复的layer为评论对象的layer+1
  private Integer layer;
}

通知对象 Notification

private Integer id;
private Integer topicId;
private Integer userId;
// 通知对象ID
private Integer targetUserId;
// 动作: REPLY, COMMENT, COLLECT, TOPIC_UP, COMMENT_UP
private String action;
private Date inTime;
private String content;
// 是否已读
private Boolean read;

授权登录对象 OAuthUser

private Integer id;
// oauth帐号的id
private Integer oauthId;
// 帐号类型，GITHUB, QQ, WECHAT, WEIBO 等
private String type;
// oauth帐号的登录名
private String login;
private String accessToken;
private Date inTime;
// 个人简介
private String bio;
private String email;
// 本地用户的id
private Integer userId;