Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leibnizhu/vertxearch
一个基于Vert.X的站内文章搜索引擎,为Vert.X中国论坛(https://github.com/VertxChinaUserGroup/vertx-cn-website, 建设ing)提供.
https://github.com/leibnizhu/vertxearch
Last synced: 8 days ago
JSON representation
一个基于Vert.X的站内文章搜索引擎,为Vert.X中国论坛(https://github.com/VertxChinaUserGroup/vertx-cn-website, 建设ing)提供.
- Host: GitHub
- URL: https://github.com/leibnizhu/vertxearch
- Owner: Leibnizhu
- License: gpl-3.0
- Created: 2018-05-11T16:55:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-03T02:48:21.000Z (12 months ago)
- Last Synced: 2024-04-16T20:11:12.567Z (7 months ago)
- Language: Scala
- Homepage:
- Size: 282 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vertXearch
一个基于Vert.X的站内文章搜索引擎,为Vert.X中国论坛提供.
## 架构
第一期:Vert.X+Lucene+HanLP,快速构建
第二期:考虑使用Vert.X改造Lucene,提高性能
目前项目提供了两个Verticle:
- `io.github.leibnizhu.vertxearch.verticle.HttpSearchVerticle`: 提供http查询接口, 默认监听8083端口
- `io.github.leibnizhu.vertxearch.verticle.EventbusSearchVerticle`: 提供Eventbus查询接口, 默认监听地址为`"search"`
默认的打包配置里使用http查询接口的Verticle.
## 使用
本项目已提交到[Maven中央仓库](https://search.maven.org/#artifactdetails%7Cio.github.leibnizhu%7Cvertxearch%7C0.0.2%7Cjar), 如果只需要使用Eventbus查询接口,可以直接使用maven依赖即可:
```xml
io.github.leibnizhu
vertXearch
0.0.2
```
或gradle:
```groovy
compile 'io.github.leibnizhu:vertXearch:0.0.2'
```
此时可以跳过下面的[编译打包](#编译打包)步骤.
2019-07注:仓库中版本较旧
### 编译打包
本项目支持使用`Maven`和`Gradle`进行构建,任选一个就可以.
使用`Maven`进行构建:
```bash
mvn clean package
```
使用`Gradle`进行构建,默认任务是清空,测试并打jar包
```bash
gradle
```
### 配置文件
配置文件模板位于: `src/main/resources/config.json`
Gradle默认任务会将其复制到项目根目录, 运行时可以直接读取到.
也可以手动复制到任意地方或整合到现有配置文件(以`/path/to/config.json`为例),修改其配置:
```json
{
/*索引存放位置*/
"indexPath": "src/test/data/Index",
/*文章原始文件位置*/
"articlePath": "src/test/data/Articles",
/*从articlePath更新索引的时间间隔,单位:秒*/
"refreshIndexPerSecond": 10,
/*服务端口*/
"serverPort": 8083,
/*EventBus监听地址*/
"eventbusAddress": "search",
/*返回的关键词前置标签,默认红色字体*/
"keywordPreTag": "",
/*返回的关键词后置标签,要和前置标签闭合*/
"keywordPostTag":""
}
```
**注**: 文章存储在${articlePath} 下的多层目录中的惊悚文件(名为`publication.json`), 一个json文件对应一篇文章,最后一层目录名为文章ID, 文件内容全部当做文章内容并全做做索引. 如 `Articles/2019/07/03/17/0e99eb3f-ccfe-4846-a35e-3749e25e9ea3/publication.json`的ID为`0e99eb3f-ccfe-4846-a35e-3749e25e9ea3`
### 启动http查询服务(作为独立Java应用)
**注1**: 默认配置的main类是用于启动http查询接口的,如果要启动eventbus查询接口的,请自行deploy.
**注2**: 配置文件路径可选, 默认读取当前目录下的`config.json`文件,如不存在, 则使用默认值(详见`Constants`代码)
```bash
java -jar target/vertxearch-0.0.2-fat.jar [/path/to/config.json]
```
提供了一个简单的查询页面: [http://localhost:8083/static/](http://localhost:8083/static/)
## 接口
### HTTP查询接口
- 地址: http://<ip>:<port>/q/<keyword>/[maxLength]
- 参数: keyword=关键词,必填;maxLength=查询结果的最大个数,可选,默认值是`Constants.MAX_SEARCH`
- 返回格式: JSON
- 返回值实例:
1. 正常返回:
(有搜索结果):
```json
{
"status": "success",
"cost": 29, /*查询耗时,单位毫秒*/
"results": [
{
"id": "7",
"title": "clojure:hellovert.x(vertx-lang-clojure发布)",
"author": "对对对",
"content": "......上实现clojure语言......：vert.x上的clojure语言支持（项目已开源）......"
},
/*........其他搜索结果........*/
{
"id": "8",
"title": "关于vert.x的冷知识",
"author": "ABC",
"content": "......，详细见：etagsoc2018clojure的符号是......"
}
]
}
```
或:(无搜索结果)
```json
{
"status": "success",
"cost": 29, /*查询耗时,单位毫秒*/
"results": []
}
```
2. 错误返回:
```json
{
"status": "error",
"message": "后台发生爆炸事故"
}
```
### Eventbus查询接口
- 地址: 默认是`"search"`, 可以通过配置文件修改,详见[`修改配置文件`](#修改配置文件)小节
- 请求格式: 接收`JsonObject`对象,格式如下:
```json
{
"method" : "search",
"content": {
"keyword": "搜索关键词",
"length": "搜索结果最大条数,正整数,选填"
}
}
```
**注1**: 以上json各个key均可在`EventbusRequestUtil`对象中进行修改.
**注2**: 可以通过`EventbusRequestUtil`对象的以下方法快速构建请求json对象(由于是单例对象,在Java和Scala中都可以直接通过类名调用以下方法):
```scala
def searchRequest(keyword: String): JsonObject
def searchRequest(keyword: String, length: Int): JsonObject
```
- 返回格式: JSON
- 返回值实例: 与HTTP接口返回格式一致