Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/houbb/word-checker
🇨🇳🇬🇧Chinese and English word spelling corrector.(中文易错别字检测，中文拼写检测纠正。英文单词拼写校验工具)
https://github.com/houbb/word-checker
cc csc english-word java nlp spelling spelling-correction word
Last synced: 6 days ago
JSON representation
🇨🇳🇬🇧Chinese and English word spelling corrector.(中文易错别字检测，中文拼写检测纠正。英文单词拼写校验工具)
- Host: GitHub
- URL: https://github.com/houbb/word-checker
- Owner: houbb
- License: apache-2.0
- Created: 2018-04-27T22:56:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-06T02:31:52.000Z (over 1 year ago)
- Last Synced: 2023-11-07T16:10:19.719Z (about 1 year ago)
- Topics: cc, csc, english-word, java, nlp, spelling, spelling-correction, word
- Language: Java
- Homepage:
- Size: 4.75 MB
- Stars: 191
- Watchers: 4
- Forks: 46
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 项目简介
> [英文文档](README_EN.md)
[word-checker](https://github.com/houbb/word-checker/) 本项目用于单词拼写检查。支持英文单词拼写检测，和中文拼写检测。
[](http://mvnrepository.com/artifact/com.github.houbb/word-checker)
[](https://www.travis-ci.org/houbb/word-checker?branch=master)
[](https://coveralls.io/github/houbb/word-checker?branch=master)
[](https://github.com/houbb/word-checker/blob/master/LICENSE.txt)
[](https://github.com/houbb/word-checker)
# 特性说明
### 支持英文的单词纠错
- 可以迅速判断当前单词是否拼写错误
- 可以返回最佳匹配结果
- 可以返回纠正匹配列表，支持指定返回列表的大小
- 错误提示支持 i18n
- 支持大小写、全角半角格式化处理
- 支持自定义词库
- 内置 27W+ 的英文词库
- 支持指定英文的编辑距离
### 支持基本的中文拼写检测
# 变更日志
> [变更日志](https://github.com/houbb/word-checker/blob/master/CHANGELOG.md)
# 快速开始
## JDK 版本
Jdk 1.7+
## maven 引入
```xml
com.github.houbb
word-checker
1.1.0
```
## 测试案例
会根据输入，自动返回最佳纠正结果。
```java
final String speling = "speling";
Assert.assertEquals("spelling", WordCheckerHelper.correct(speling));
```
# 核心 api 介绍
核心 api 在 `WordCheckerHelper` 工具类下。
`WordCheckerHelper` 工具类提供了长文本中英文混合的自动纠正功能，当然也支持单个单词。
| 功能 | 方法 | 参数 | 返回值 | 备注 |
|:----|:------------------------------|:----|:----------------------------|:---------------------|
| 文本拼写是否正确 | isCorrect(string) | 待检测的文本 | boolean | 全部正确，才会返回 true |
| 返回最佳纠正结果 | correct(string) | 待检测的单词 | String | 如果没有找到可以纠正的文本，则返回其本身 |
| 判断文本拼写是否正确 | correctMap(string) | 待检测的单词 | `Map>` | 返回所有匹配的纠正列表 MAP |
| 判断文本拼写是否正确 | correctMap(string, int limit) | 待检测的文本, 返回列表的大小 | 返回指定大小的的纠正列表 MAP | 列表大小 <= limit |
| 判断文本拼写是否正确 | correctList(string) | 待检测的单词 | `List` | 返回所有匹配的纠正列表 |
| 判断文本拼写是否正确 | correctList(string, int limit) | 待检测的文本, 返回列表的大小 | 返回指定大小的的纠正列表 | 列表大小 <= limit |
## 英文测试例子
> 参见 [EnWordCheckerTest.java](https://github.com/houbb/word-checker/tree/master/src/test/java/com/github/houbb/word/checker/util/WordCheckerHelperTest.java)
### 是否拼写正确
```java
final String hello = "hello";
final String speling = "speling";
Assert.assertTrue(WordCheckerHelper.isCorrect(hello));
Assert.assertFalse(WordCheckerHelper.isCorrect(speling));
```
### 返回最佳匹配结果
```java
final String hello = "hello";
final String speling = "speling";
Assert.assertEquals("hello", WordCheckerHelper.correct(hello));
Assert.assertEquals("spelling", WordCheckerHelper.correct(speling));
```
### 默认纠正匹配列表
```java
final String word = "goox";
List stringList = WordCheckerHelper.correctList(word);
Assert.assertEquals("[good, goo, goon, goof, gook, goop, goos, gox, goog, gool, goor]", stringList.toString());
```
### 指定纠正匹配列表大小
```java
final String word = "goox";
final int limit = 2;
List stringList = WordCheckerHelper.correctList(word, limit);
Assert.assertEquals("[good, goo]", stringList.toString());
```
## 中文拼写纠正
### 是否拼写正确
```java
final String right = "正确";
final String error = "万变不离其中";
Assert.assertTrue(WordCheckerHelper.isCorrect(right));
Assert.assertFalse(WordCheckerHelper.isCorrect(error));
```
### 返回最佳匹配结果
```java
final String right = "正确";
final String error = "万变不离其中";
Assert.assertEquals("正确", WordCheckerHelper.correct(right));
Assert.assertEquals("万变不离其宗", WordCheckerHelper.correct(error));
```
### 默认纠正匹配列表
```java
final String word = "万变不离其中";
List stringList = WordCheckerHelper.correctList(word);
Assert.assertEquals("[万变不离其宗]", stringList.toString());
```
### 指定纠正匹配列表大小
```java
final String word = "万变不离其中";
final int limit = 1;
List stringList = WordCheckerHelper.correctList(word, limit);
Assert.assertEquals("[万变不离其宗]", stringList.toString());
```
## 长文本中英文混合
### 情景
实际拼写纠正的话，最佳的使用体验是用户输入一个长文本，并且可能是中英文混合的。
然后实现上述对应的功能。
### 拼写是否正确
```java
final String hello = "hello 你好";
final String speling = "speling 你好 以毒功毒";
Assert.assertTrue(WordCheckers.isCorrect(hello));
Assert.assertFalse(WordCheckers.isCorrect(speling));
```
### 返回最佳纠正结果
```java
final String hello = "hello 你好";
final String speling = "speling 你好以毒功毒";
Assert.assertEquals("hello 你好", WordCheckers.correct(hello));
Assert.assertEquals("spelling 你好以毒攻毒", WordCheckers.correct(speling));
```
### 判断文本拼写是否正确
每一个词，对应的纠正结果。
```java
final String hello = "hello 你好";
final String speling = "speling 你好以毒功毒";
Assert.assertEquals("{hello=[hello], =[ ], 你=[你], 好=[好]}", WordCheckers.correctMap(hello).toString());
Assert.assertEquals("{ =[ ], speling=[spelling, spewing, sperling, seeling, spieling, spiling, speeling, speiling, spelding], 你=[你], 好=[好], 以毒功毒=[以毒攻毒]}", WordCheckers.correctMap(speling).toString());
```
### 判断文本拼写是否正确
同上，指定最多返回的个数。
```java
final String hello = "hello 你好";
final String speling = "speling 你好以毒功毒";
Assert.assertEquals("{hello=[hello], =[ ], 你=[你], 好=[好]}", WordCheckers.correctMap(hello, 2).toString());
Assert.assertEquals("{ =[ ], speling=[spelling, spewing], 你=[你], 好=[好], 以毒功毒=[以毒攻毒]}", WordCheckers.correctMap(speling, 2).toString());
```
# 格式化处理
有时候用户的输入是各式各样的，本工具支持对于格式化的处理。
## 大小写
大写会被统一格式化为小写。
```java
final String word = "stRing";
Assert.assertTrue(WordCheckerHelper.isCorrect(word));
```
## 全角半角
全角会被统一格式化为半角。
```java
final String word = "stｒing";
Assert.assertTrue(WordCheckerHelper.isCorrect(word));
```
# 自定义英文词库
## 文件配置
你可以在项目资源目录创建文件 `resources/data/define_word_checker_en.txt`
内容如下：
```
my-long-long-define-word,2
my-long-long-define-word-two
```
不同的词独立一行。
每一行第一列代表单词，第二列代表出现的次数，二者用逗号 `,` 隔开。
次数越大，在纠正的时候返回优先级就越高，默认值为 1。
用户自定义的词库优先级高于系统内置词库。
## 测试代码
我们在指定了对应的单词之后，拼写检测的时候就会生效。
```java
final String word = "my-long-long-define-word";
final String word2 = "my-long-long-define-word-two";
Assert.assertTrue(WordCheckerHelper.isCorrect(word));
Assert.assertTrue(WordCheckerHelper.isCorrect(word2));
```
# 自定义中文词库
## 文件配置
你可以在项目资源目录创建文件 `resources/data/define_word_checker_zh.txt`
内容如下：
```
默守成规 墨守成规
```
使用英文空格分隔，前面是错误，后面是正确。
# NLP 开源矩阵
[pinyin 汉字转拼音](https://github.com/houbb/pinyin)
[pinyin2hanzi 拼音转汉字](https://github.com/houbb/pinyin2hanzi)
[segment 高性能中文分词](https://github.com/houbb/segment)
[opencc4j 中文繁简体转换](https://github.com/houbb/opencc4j)
[nlp-hanzi-similar 汉字相似度](https://github.com/houbb/nlp-hanzi-similar)
[word-checker 拼写检测](https://github.com/houbb/word-checker)
[sensitive-word 敏感词](https://github.com/houbb/sensitive-word)
# 后期 Road-Map
- [x] 支持英文分词，处理整个英文句子
- 支持中文分词拼写检测
- 引入中文纠错算法，同音字和形近字处理。
- 支持中英文混合拼写检测
# 技术鸣谢
[Words](https://github.com/atebits/Words) 提供的原始英语单词数据。