RapidOcr-Java

Introduction: 🔥🔥🔥Java 代码实现调用 RapidOCR(基于 PaddleOCR),适配 Mac、Win、Linux,支持最新 PP-OCRv4
More: Author   ReportBugs   
Tags:

😺 项目起源

  • 现有的 JavaOCR 工具包识别效果差强人意,PaddleOCR在实现前沿算法的基础上,考虑精度与速度的平衡,进行模型瘦身和深度优化,使其尽可能满足产业落地需求。
  • PaddleOCR 官方并未提供 Java 版本,而RapidOcr解决了这个问题,其提供了 Kotlin 和 Java 混合版本的Demo-onnxDemo-ncnn
  • 而实际使用过程中 项目中并不想再引入 Kotlin、不想了解 OCR 相关知识,开箱即用、不想额外再部署 OCR 服务

因此本项目将 Kotlin 部分移除,并在此基础上加以完善且提供了更友好的的调用方法,更方便 java 开发者直接进行使用。

✨如果该项目对您有帮助,您的 star 是我不断优化的动力!!!

👏 项目特点

  • 纯 Java 代码调用 RapidOcr
  • 集成 ncnn 和 onnx 推理引擎方式
  • 均使用 CPU 版本,GPU 版本请自行编译
  • 支持 Mac、Windows、Linux 等多平台,详细支持的系统请查看版本说明

🎉 快速开始

项目提供了JavaEESpringBoot 的使用 Demo,仅作参考(可以拉取下来运行试一下)

1️⃣ 添加依赖

此种方式会根据你使用的系统自动使用对应的 jar 包,目前支持的系统请查看版本说明

<!--  rapidocr 这个必须要引入     -->
<!--  可前往 maven 中央仓库 https://central.sonatype.com/artifact/io.github.mymonstercat/rapidocr/versions,查看版本      -->
<dependency>
    <groupId>io.github.mymonstercat</groupId>
    <artifactId>rapidocr</artifactId>
    <version>0.0.7</version>
</dependency>

<!--  一般只需要引入一个,CPU 端建议使用 onnx,移动端建议使用 ncnn     -->
<!--  可前往 maven 中央仓库 https://central.sonatype.com/artifact/io.github.mymonstercat/rapidocr-onnx-platform/versions,查看版本      -->
<dependency>
    <groupId>io.github.mymonstercat</groupId>
    <artifactId>rapidocr-onnx-platform</artifactId>
    <version>0.0.7</version>
</dependency>

<dependency>
    <groupId>io.github.mymonstercat</groupId>
    <artifactId>rapidocr-ncnn-platform</artifactId>
    <version>0.0.7</version>
</dependency>

⚠️ 如果你想体验最新功能,请拉取 main 分支代码,自己打包后进行使用!!!

2️⃣ 使用示例

public class Main {
    public static void main(String[] args) {
        InferenceEngine engine = InferenceEngine.getInstance(Model.ONNX_PPOCR_V3);
        OcrResult ocrResult = engine.runOcr("/images/test.png");
        System.out.println(ocrResult.getStrRes().trim());
    }
}

更多使用示例请参考使用示例

3️⃣ 添加打印日志(可选)

项目中添加了日志打印,方便打印 OCR 日志,请自行添加日志实现(springboot 自带,可以不用添加)

<!-- 非 SpringBoot 项目:例如添加 slf4j-simple     -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-simple</artifactId>
    <version>2.0.3</version>
</dependency>
<!-- SpringBoot 项目:去除依赖,防止冲突     -->
<dependency>
    <groupId>io.github.mymonstercat</groupId>
    <artifactId>rapidocr</artifactId>
    <exclusions>
        <exclusion>
            <artifactId>slf4j-api</artifactId>
            <groupId>org.slf4j</groupId>
        </exclusion>
    </exclusions>
</dependency>

添加后效果如下:

⚠️ 注意:当前 JVM 启动时只能同时启动一种推理引擎,以第一次调用 runOcr 方法时的引擎配置为准

🔝 进阶使用

📌 TODO

  • [x] 根据系统版本自适应加载动态库
  • [x] 动态库集成到 jar 中
  • [x] 是否删除临时文件夹配置为可选项
  • [x] CentOS7 升级指引
  • [x] 添加日志,规范日志打印
  • [x] ONNX 支持 Mac-Arm64
  • [ ] 支持 Docker 镜像
  • [x] Maven 仓库提供 packages
  • [ ] SpringBoot 下,以配置文件方式改造
  • [x] jvm 未退出场景连续调用识别结果集乱码#1
  • [x] 集成 ONNX#2,感谢nn200433tika-server👏
  • [x] 多模块打包#6
  • [x] 多线程情况下库和模型可能重复加载、编译目标 jdk 版本改为 1.8,感谢FlyInWind1
  • [x] 基于 arm64 的银河麒麟环境,提供 linux-arm64 下 onnx 运行库(编译过程详见进阶使用),感谢sandywalker
  • [x] 添加英语日志,感谢litongjava
  • [x] 支持传入 bitmap 和 image 的二进制数据,感谢scvzerng

🤔 FAQ

Q1:CentOS7 无法运行?

Q2:如何传入二进制数据,而非图片路径?

由于缺少其他系统的设备,因此暂不提供最新的 jar 包(也就用 v0.0.7 传不了二进制),可参考以下步骤自行编译可传入二进制数据的 jar 包

⚠️ 如果你是 mac-arm64 的设备,直接 拉取项目、运行测试用例即可(也就是目前仅 mac-arm64 的动态库是支持二进制传入的!)

Q3:如何使用其他版本(如服务器版本)的模型?

  • 拉取本项目最新代码到本地
  • 该路径下放入模型文件
  • 模型中添加对应的配置
  • 项目执行打包命令

Q4:如何更新模型?

如有其他问题请提 issue,我会尽快解决。

鸣谢

开源许可

使用 Apache License 2.0

Apps
About Me
GitHub: Trinea
Facebook: Dev Tools