RapidOcr-Java 安装与使用指南

项目简介

RapidOcr-Java 是一个基于 PaddleOCR 的 Java 实现光学字符识别工具，专为 Java 开发者设计，让 OCR 技术集成变得简单高效。该项目移除了 Kotlin 依赖，提供了纯 Java 的调用方式，方便开发者直接使用。

核心特性

• 纯 Java 代码调用 RapidOcr
• 集成 ncnn 和 onnx 两种推理引擎
• 均使用 CPU 版本，GPU 版本需自行编译
• 支持 Mac、Windows、Linux 等多平台

快速开始

环境要求

• Java Development Kit (JDK) 1.8 或更高版本
• Maven 项目管理工具
• 支持 Linux、MacOS、Windows 操作系统

第一步：添加项目依赖

在项目的 pom.xml 文件中添加以下依赖：

<!-- RapidOcr 主库，必须引入 -->
<dependency>
    <groupId>io.github.mymonstercat</groupId>
    <artifactId>rapidocr</artifactId>
    <version>0.0.7</version>
</dependency>

<!-- 选择推理引擎，一般只需要引入一个 -->
<!-- CPU 端建议使用 onnx，移动端建议使用 ncnn -->
<dependency>
    <groupId>io.github.mymonstercat</groupId>
    <artifactId>rapidocr-onnx-platform</artifactId>
    <version>0.0.7</version>
</dependency>

<!-- 或者使用 ncnn 引擎 -->
<dependency>
    <groupId>io.github.mymonstercat</groupId>
    <artifactId>rapidocr-ncnn-platform</artifactId>
    <version>0.0.7</version>
</dependency>

第二步：基本使用示例

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());
    }
}

第三步：日志配置（可选）

对于非 SpringBoot 项目，可以添加 SLF4J 简单实现：

<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>

项目结构说明

RapidOcr-Java 采用多模块架构设计：

• rapidocr - 核心模块，包含 OCR 引擎和主要接口
• rapidocr-common - 公共工具模块
• rapidocr-onnx-platform - ONNX 推理引擎平台
• rapidocr-ncnn-platform - NCNN 推理引擎平台
• rapidocr-onnx-models - ONNX 模型管理
• rapidocr-ncnn-models - NCNN 模型管理

运行效果展示

配置完成后，运行 OCR 识别将输出如下结果：

注意事项

• 当前 JVM 启动时只能同时启动一种推理引擎，以第一次调用 runOcr 方法时的引擎配置为准
• 如需体验最新功能，请拉取 main 分支代码自行打包使用
• 不同平台需要对应的动态库支持

进阶使用

如需了解更多高级功能，请参考项目文档：

• 参数调优与版本说明：docs/ADVANCED.md
• 如何打包 jar 包在 Linux 系统上运行：docs/COMPILE_JAR.md
• 不同系统环境配置指南：docs/CentOS7.md
• 性能比对分析：docs/COMPARE.md

常见问题

CentOS7 无法运行？

请参考 CentOS7 升级 GCC 文档：docs/CentOS7.md

如何传入二进制数据？

可参考测试用例中的实现方式，支持传入 bitmap 和 image 的二进制数据。

如何使用其他版本模型？

在模型路径下放入模型文件，并在配置中添加对应的模型配置。

开源许可

本项目使用 Apache License 2.0 开源协议。