[开源]一言·古诗词 API，随机返回一条古诗词名句。采用 Vert.x 全异步开发，毫秒级稳定响应。支持 svg / png / json / txt 返回

lhx2008
1,348 阅读2分钟

一言·古诗词 API

（掘金会自动替换图片，所以不会自动换，没办法）

简介

古诗词·一言API 是一个可以随机返回一句古诗词名句的接口。具有以下特点：

  • 快：使用 Vert.x Java 全异步框架开发，使用Redis数据库，确保毫秒级稳定响应。
  • 全：支持 svg / txt / json / png 调用，满足你在任何地方的调用需求
  • 准：可以根据你的喜好，在指定的分类中进行随机返回

本仓库是该项目的开源代码仓库，仅提供测试数据，其余数据请自行采集。

项目首页：gushi.ci

GitHub首页：github.com/xenv/gushic…

安装

  1. 根据 Maven 安装依赖

  2. maven package 可打成 Jar 包

  3. 配置 redis，导入 dump.rdb 数据 （放到 redis 目录下，重启 redis，如果原来有这个文件请自行导出数据再替换，原有数据会全部清除）

  4. 运行：

    1. 服务器运行 java -server -jar yiyan-1.0-fat.jar -conf conf.json conf.json从下面可以复制出来自己配
    2. IDE运行 启动类 io.vertx.core.Launcher 参数 run ma.luan.yiyan.MainVerticle -conf src/main/resources/conf.json

  5. 如果要自行采集数据，请仿照原有 redis 中的 key 格式采集，log自动添加，help为可选，需要自己填充 json 和 img 两个 key 集。古诗词数据每个分类一个 set，set的内容是 json 或者 base64 加密的图片。其他细节请自行查看源码。

使用

见 Github

技术说明

  1. MainVerticle 用来部署其他 Verticle
  2. ApiVerticle 为核心部分，负责处理请求
  3. DataService 和 LogService 负责提供查询服务
  4. ConvertUtil 负责转码
  5. Service 没有使用 Service Proxy，因此无需额外生成代码。

更新历史

  • 2018.08.06 1.1:
    1. 引入前缀树，使分类检索效率由 O(n) (n为所有分类数) 变为 O(L) (L为分类级数)。 缺点是空间复杂度由 O(n) 变为 O(nL)，代码复杂度增加60行
    2. 优化了正则匹配获取地址参数的逻辑
    3. 正确加入了全局的错误处理（包括 Router 和 EventBus）
  • 2018.08.05 1.0：初始版本，支持 4 种格式返回，支持按分类搜索

关于项目

这是我的个人项目，目的是为了弘扬中国传统文化。

名句数据由古诗文网收录整理，特此感谢。

若有任何建议，或者有工作实习的机会（本人大学在读），请联系 meetlhx#qq.com

若您对本人的其他作品或者文章感兴趣，请访问我的博客：luan.ma

avatar
文章
阅读
粉丝