mirror of
https://github.com/yanyiwu/cppjieba.git
synced 2025-07-18 00:00:12 +08:00
416 lines
12 KiB
Markdown
416 lines
12 KiB
Markdown
# CppJieba [](https://travis-ci.org/yanyiwu/cppjieba)
|
||
|
||
## 简介
|
||
|
||
CppJieba是"结巴"中文分词的C++版本
|
||
|
||
代码细节详解请见 [代码详解]
|
||
|
||
## 特性
|
||
|
||
+ 源代码都写进头文件`src/*.hpp`里，`include`即可使用。
|
||
+ 支持`utf-8, gbk`编码，但是推荐使用`utf-8`编码， 因为`gbk`编码缺少严格测试，慎用。
|
||
+ 内置分词服务`server/server.cpp`，在linux环境下可安装使用(可选)，可通过http参数选择不同分词算法进行分词。
|
||
+ 项目自带较为完善的单元测试，核心功能中文分词(utf8)的稳定性接受过线上环境检验。
|
||
+ 支持载自定义用户词典。
|
||
+ 支持 `linux` , `mac osx` 操作系统。
|
||
+ 支持 `Docker`。
|
||
+ 提供 C语言 api接口调用 [cjieba]。
|
||
|
||
## 用法
|
||
|
||
### 依赖软件
|
||
|
||
* `g++ (version >= 4.1 recommended) or clang++`;
|
||
* `cmake (version >= 2.6 recommended)`;
|
||
|
||
### 下载和编译
|
||
|
||
```sh
|
||
git clone --depth=10 --branch=master git://github.com/yanyiwu/cppjieba.git
|
||
cd cppjieba
|
||
mkdir build
|
||
cd build
|
||
cmake ..
|
||
make
|
||
```
|
||
|
||
有兴趣的可以跑跑测试(可选):
|
||
|
||
```
|
||
make test
|
||
```
|
||
|
||
## Demo
|
||
|
||
```
|
||
./demo
|
||
```
|
||
|
||
结果示例：
|
||
|
||
```
|
||
[demo] METHOD_MP
|
||
我/是/拖拉机/学院/手扶拖拉机/专业/的/。/不用/多久/，/我/就/会/升职/加薪/，/当/上/C/E/O/，/走上/人生/巅峰/。
|
||
|
||
[demo] METHOD_HMM
|
||
我/是/拖拉机/学院/手/扶/拖拉机/专业/的/。/不用/多久/，/我/就/会升/职加薪/，/当上/CEO/，/走上/人生/巅峰/。
|
||
|
||
[demo] METHOD_MIX
|
||
我/是/拖拉机/学院/手扶拖拉机/专业/的/。/不用/多久/，/我/就/会/升职/加薪/，/当上/CEO/，/走上/人生/巅峰/。
|
||
|
||
[demo] METHOD_FULL
|
||
我/是/拖拉/拖拉机/学院/手扶/手扶拖拉机/拖拉/拖拉机/专业/的/。/不用/多久/，/我/就/会升/升职/加薪/，/当上/C/E/O/，/走上/人生/巅峰/。
|
||
[demo] METHOD_QUERY
|
||
我/是/拖拉机/学院/手扶/手扶拖拉机/拖拉/拖拉机/专业/的/。/不用/多久/，/我/就/会/升职/加薪/，/当上/CEO/，/走上/人生/巅峰/。
|
||
|
||
[demo] TAGGING
|
||
我是拖拉机学院手扶拖拉机专业的。不用多久，我就会升职加薪，当上CEO，走上人生巅峰。
|
||
["我:r", "是:v", "拖拉机:n", "学院:n", "手扶拖拉机:n", "专业:n", "的:uj", "。:x", "不用:v", "多久:m", "，:x", "我:r", "就:d", "会:v", "升职:v", "加薪:nr", "，:x", "当上:t", "CEO:eng", "，:x", "走上:v", "人生:n", "巅峰:n", "。:x"]
|
||
|
||
[demo] KEYWORD
|
||
我是拖拉机学院手扶拖拉机专业的。不用多久，我就会升职加薪，当上CEO，走上人生巅峰。
|
||
["CEO:11.7392", "升职:10.8562", "加薪:10.6426", "手扶拖拉机:10.0089", "巅峰:9.49396"]
|
||
```
|
||
|
||
详细请看 `test/demo.cpp`.
|
||
|
||
|
||
## 服务使用
|
||
|
||
服务默认使用 MixSegment 切词方式，如果想要修改成其他方式，请参考 `server/server.cpp` 源码文件。
|
||
将对应的方式的代码行注释去掉，重新编译即可。
|
||
|
||
### 启动服务
|
||
|
||
```
|
||
./bin/cjserver ../conf/server_example.conf
|
||
```
|
||
|
||
### 客户端请求示例
|
||
|
||
```
|
||
curl "http://127.0.0.1:11200/?key=南京市长江大桥"
|
||
```
|
||
|
||
```
|
||
["南京市", "长江大桥"]
|
||
```
|
||
|
||
```
|
||
curl "http://127.0.0.1:11200/?key=南京市长江大桥&format=simple"
|
||
```
|
||
|
||
```
|
||
南京市 长江大桥
|
||
```
|
||
|
||
默认切词算法是MixSegment切词算法，如果想要使用其他算法切词，可以使用参数method来设置。
|
||
示例如下：
|
||
|
||
```
|
||
curl "http://127.0.0.1:11200/?key=南京市长江大桥&format=simple&method=MP"
|
||
curl "http://127.0.0.1:11200/?key=南京市长江大桥&format=simple&method=HMM"
|
||
curl "http://127.0.0.1:11200/?key=南京市长江大桥&format=simple&method=MIX"
|
||
curl "http://127.0.0.1:11200/?key=南京市长江大桥&format=simple&method=FULL"
|
||
curl "http://127.0.0.1:11200/?key=南京市长江大桥&format=simple&method=QUERY"
|
||
```
|
||
|
||
用 chrome 浏览器打开也行 ( chrome 设置默认编码是`utf-8`):
|
||
|
||
同时，也支持HTTP POST模式，使用如下调用:
|
||
|
||
```
|
||
curl -d "南京市长江大桥" "http://127.0.0.1:11200/"
|
||
```
|
||
|
||
返回结果如下：
|
||
|
||
```
|
||
["南京市", "长江大桥"]
|
||
```
|
||
|
||
因为 HTTP GET 请求有长度限制，如果需要请求长文的，请使用POST请求。
|
||
|
||
### 安装服务(仅限 linux 系统)
|
||
|
||
如果有需要**安装使用**的，可以按照如下操作：
|
||
```
|
||
sudo make install
|
||
```
|
||
|
||
### 服务启动和停止(仅限 linux 系统)
|
||
|
||
```
|
||
cd /usr/local/cppjieba
|
||
./script/cjserver.start
|
||
./script/cjserver.stop
|
||
```
|
||
|
||
### 卸载服务(仅限 linux 系统)
|
||
|
||
```sh
|
||
rm -rf /usr/local/cppjieba
|
||
```
|
||
|
||
## Docker 示例
|
||
|
||
安装和启动
|
||
|
||
```
|
||
sudo docker pull yanyiwu/cppjieba
|
||
sudo docker run -d -P yanyiwu/cppjieba
|
||
```
|
||
|
||
```
|
||
sudo docker ps
|
||
```
|
||
|
||
```
|
||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||
7c29325e9c20 yanyiwu/cppjieba:latest "./bin/cjserver ../t 4 minutes ago Up 4 minutes 0.0.0.0:49160->11200/tcp angry_wilson
|
||
```
|
||
|
||
可以看到正在运行的 Docker 容器(容器内运行着 `cjserver` 服务)，并且服务的端口号被映射为 `0.0.0.0:49160` 。
|
||
|
||
所以现在可以来一发测试了：
|
||
|
||
```
|
||
curl "http://0.0.0.0:49160/?key=南京市长江大桥"
|
||
```
|
||
|
||
预期结果如下：
|
||
|
||
```
|
||
["南京市", "长江大桥"]
|
||
```
|
||
|
||
### 分词结果示例
|
||
|
||
**MPSegment**
|
||
|
||
Output:
|
||
```
|
||
我来到北京清华大学
|
||
我/来到/北京/清华大学
|
||
|
||
他来到了网易杭研大厦
|
||
他/来到/了/网易/杭/研/大厦
|
||
|
||
小明硕士毕业于中国科学院计算所，后在日本京都大学深造
|
||
小/明/硕士/毕业/于/中国科学院/计算所/，/后/在/日本京都大学/深造
|
||
|
||
```
|
||
|
||
**HMMSegment**
|
||
|
||
```
|
||
我来到北京清华大学
|
||
我来/到/北京/清华大学
|
||
|
||
他来到了网易杭研大厦
|
||
他来/到/了/网易/杭/研大厦
|
||
|
||
小明硕士毕业于中国科学院计算所，后在日本京都大学深造
|
||
小明/硕士/毕业于/中国/科学院/计算所/，/后/在/日/本/京/都/大/学/深/造
|
||
|
||
```
|
||
|
||
**MixSegment**
|
||
|
||
```
|
||
我来到北京清华大学
|
||
我/来到/北京/清华大学
|
||
|
||
他来到了网易杭研大厦
|
||
他/来到/了/网易/杭研/大厦
|
||
|
||
小明硕士毕业于中国科学院计算所，后在日本京都大学深造
|
||
小明/硕士/毕业/于/中国科学院/计算所/，/后/在/日本京都大学/深造
|
||
|
||
```
|
||
|
||
**FullSegment**
|
||
|
||
```
|
||
我来到北京清华大学
|
||
我/来到/北京/清华/清华大学/华大/大学
|
||
|
||
他来到了网易杭研大厦
|
||
他/来到/了/网易/杭/研/大厦
|
||
|
||
小明硕士毕业于中国科学院计算所，后在日本京都大学深造
|
||
小/明/硕士/毕业/于/中国/中国科学院/科学/科学院/学院/计算/计算所/，/后/在/日本/日本京都大学/京都/京都大学/大学/深造
|
||
|
||
```
|
||
|
||
**QuerySegment**
|
||
|
||
```
|
||
我来到北京清华大学
|
||
我/来到/北京/清华/清华大学/华大/大学
|
||
|
||
他来到了网易杭研大厦
|
||
他/来到/了/网易/杭研/大厦
|
||
|
||
小明硕士毕业于中国科学院计算所，后在日本京都大学深造
|
||
小明/硕士/毕业/于/中国/中国科学院/科学/科学院/学院/计算所/，/后/在/中国/中国科学院/科学/科学院/学院/日本/日本京都大学/京都/京都大学/大学/深造
|
||
|
||
```
|
||
|
||
以上依次是MP,HMM,Mix三种方法的效果。
|
||
|
||
可以看出效果最好的是Mix，也就是融合MP和HMM的切词算法。即可以准确切出词典已有的词，又可以切出像"杭研"这样的未登录词。
|
||
|
||
Full方法切出所有字典里的词语。
|
||
|
||
Query方法先使用Mix方法切词，对于切出来的较长的词再使用Full方法。
|
||
|
||
### 自定义用户词典
|
||
|
||
自定义词典示例请看`dict/user.dict.utf8`。
|
||
|
||
没有使用自定义用户词典时的结果:
|
||
|
||
```
|
||
令狐冲/是/云/计算/行业/的/专家
|
||
```
|
||
|
||
使用自定义用户词典时的结果:
|
||
|
||
```
|
||
令狐冲/是/云计算/行业/的/专家
|
||
```
|
||
|
||
### 关键词抽取
|
||
|
||
```
|
||
我是拖拉机学院手扶拖拉机专业的。不用多久，我就会升职加薪，当上CEO，走上人生巅峰。
|
||
["CEO:11.7392", "升职:10.8562", "加薪:10.6426", "手扶拖拉机:10.0089", "巅峰:9.49396"]
|
||
```
|
||
|
||
详细请见 `test/demo.cpp`.
|
||
|
||
### 词性标注
|
||
|
||
```
|
||
我是蓝翔技工拖拉机学院手扶拖拉机专业的。不用多久，我就会升职加薪，当上总经理，出任CEO，迎娶白富美，走上人生巅峰。
|
||
["我:r", "是:v", "蓝翔:x", "技工:n", "拖拉机:n", "学院:n", "手扶拖拉机:n", "专业:n", "的:uj", "。:x", "不用:v", "多久:m", "，:x", "我:r", "就:d", "会:v", "升职:v", "加薪:nr", "，:x", "当:t", "上:f", "总经理:n", "，:x", "出任:v", "CEO:eng", "，:x", "迎娶:v", "白富美:x", "，:x", "走上:v", "人生:n", "巅峰:n", "。:x"]
|
||
```
|
||
|
||
详细请看 `test/demo.cpp`.
|
||
|
||
支持自定义词性。
|
||
比如在(`dict/user.dict.utf8`)增加一行
|
||
|
||
```
|
||
蓝翔 nz
|
||
```
|
||
|
||
结果如下：
|
||
|
||
```
|
||
["我:r", "是:v", "蓝翔:nz", "技工:n", "拖拉机:n", "学院:n", "手扶拖拉机:n", "专业:n", "的:uj", "。:x", "不用:v", "多久:m", "，:x", "我:r", "就:d", "会:v", "升职:v", "加薪:nr", "，:x", "当:t", "上:f", "总经理:n", "，:x", "出任:v", "CEO:eng", "，:x", "迎娶:v", "白富美:x", "，:x", "走上:v", "人生:n", "巅峰:n", "。:x"]
|
||
```
|
||
|
||
## 其它词典资料分享
|
||
|
||
+ [dict.367W.utf8.tar.gz] iLife(`562193561@qq.com`)
|
||
|
||
## 应用
|
||
|
||
### 关于CppJieba的跨语言包装使用
|
||
|
||
收到邮件询问跨语言包装(ios应用开发)使用的问题，这方面我没有相关的经验，建议参考如下python使用cppjieba的项目：
|
||
|
||
[jannson] 开发的供 python模块调用的项目 [cppjiebapy] , 和相关讨论 [cppjiebapy_discussion] .
|
||
|
||
### NodeJieba
|
||
|
||
如果有需要在`node.js`中使用分词，不妨试一下[NodeJieba]。
|
||
|
||
### simhash
|
||
|
||
如果有需要在处理中文文档的的相似度计算，不妨试一下[simhash]。
|
||
|
||
### exjieba
|
||
|
||
如果有需要在`erlang`中使用分词的话，不妨试一下[exjieba]。
|
||
|
||
### jiebaR
|
||
|
||
如果有需要在`R`中使用分词的话，不妨试一下[jiebaR]。
|
||
|
||
### libcppjieba
|
||
|
||
[libcppjieba] 是最简单易懂的CppJieba头文件库使用示例。
|
||
|
||
### keyword\_server
|
||
|
||
[KeywordServer] 50行搭建一个**中文关键词抽取服务**。
|
||
|
||
### ngx\_http\_cppjieba\_module
|
||
|
||
如果有需要在`Nginx`中使用分词模块的话，不妨试一下[ngx_http_cppjieba_module]。
|
||
|
||
### cjieba
|
||
|
||
如果有需要在 C语言 中使用分词模块的话，不妨试一下[cjieba]。
|
||
|
||
### jieba\_rb
|
||
|
||
如果有需要在 Ruby 中使用分词模块的话，不妨试一下[jieba_rb]。
|
||
|
||
### iosjieba
|
||
|
||
如果有需要在 iOS 开发中使用分词模块的话，不妨参考一下 [iosjieba]。
|
||
|
||
## 线上演示
|
||
|
||
http://cppjieba-webdemo.herokuapp.com/
|
||
(建议使用chrome打开)
|
||
|
||
## 性能评测
|
||
|
||
[Jieba中文分词系列性能评测]
|
||
|
||
## 客服
|
||
|
||
`i@yanyiwu.com`
|
||
|
||
|
||
|
||
## 鸣谢
|
||
|
||
"结巴"中文分词作者: SunJunyi
|
||
https://github.com/fxsjy/jieba
|
||
|
||
## 许可证
|
||
|
||
MIT http://yanyiwu.mit-license.org
|
||
|
||
## 作者
|
||
|
||
- yanyiwu https://github.com/yanyiwu i@yanyiwu.com
|
||
- aholic https://github.com/aholic ruochen.xu@gmail.com
|
||
|
||
[CppJieba]:https://github.com/yanyiwu/cppjieba
|
||
[jannson]:https://github.com/jannson
|
||
[cppjiebapy]:https://github.com/jannson/cppjiebapy
|
||
[cppjiebapy_discussion]:https://github.com/yanyiwu/cppjieba/issues/1
|
||
[NodeJieba]:https://github.com/yanyiwu/nodejieba
|
||
[jiebaR]:https://github.com/qinwf/jiebaR
|
||
[simhash]:https://github.com/yanyiwu/simhash
|
||
[代码详解]:https://github.com/yanyiwu/cppjieba/wiki/CppJieba%E4%BB%A3%E7%A0%81%E8%AF%A6%E8%A7%A3
|
||
[libcppjieba]:https://github.com/yanyiwu/libcppjieba
|
||
[issue25]:https://github.com/yanyiwu/cppjieba/issues/25
|
||
[exjieba]:https://github.com/falood/exjieba
|
||
[KeywordServer]:https://github.com/yanyiwu/keyword_server
|
||
[ngx_http_cppjieba_module]:https://github.com/yanyiwu/ngx_http_cppjieba_module
|
||
[dict.367W.utf8.tar.gz]:http://pan.baidu.com/s/1o6A0BWY
|
||
[cjieba]:http://github.com/yanyiwu/cjieba
|
||
[jieba_rb]:https://github.com/altkatz/jieba_rb
|
||
[iosjieba]:https://github.com/yanyiwu/iosjieba
|
||
|
||
[Jieba中文分词系列性能评测]:http://yanyiwu.com/work/2015/06/14/jieba-series-performance-test.html
|