上一教程： 图像监视：在 Visual Studio 调试器中查看内存中的图像
下一教程： 在 Eclipse 中使用 OpenCV Java


原作者	Eric Christiansen 和 Andrey Pavlenko
兼容性	OpenCV >= 3.0

警告: 本教程可能包含过时信息。

从 OpenCV 2.4.4 版本开始，OpenCV 支持使用与 Android 开发几乎相同的接口进行桌面 Java 开发。本指南将帮助您创建第一个使用 OpenCV 的 Java（或 Scala）应用程序。我们将使用 Apache Ant 或 Simple Build Tool (SBT) 来构建应用程序。

如果您想使用 Eclipse，请访问在 Eclipse 中使用 OpenCV Java。阅读本指南后，请参考 Android 开发入门教程。

本指南我们将做什么

在本指南中，我们将

获取支持桌面 Java 的 OpenCV
创建一个 Ant 或 SBT 项目
用 Java 或 Scala 编写一个简单的 OpenCV 应用程序

OpenCV 仓库的 samples/java 文件夹中使用的就是相同的流程创建的示例，因此如果您遇到问题，可以参考这些文件。

获取合适的 OpenCV

从 2.4.4 版本开始，OpenCV 包含桌面 Java 绑定。

下载

最简单的方法是从 OpenCV SourceForge 仓库下载合适的2.4.4 或更高版本的软件包。

注意: Windows 用户可以在软件包内的 opencv/build/java/ 文件夹中找到 Java 开发所需的预构建文件。对于其他操作系统，需要从源代码构建 OpenCV。

另一种获取 OpenCV 源代码的方法是克隆 OpenCV git 仓库。为了使用 Java 绑定构建 OpenCV，您需要安装 JDK（Java 开发工具包）（我们推荐 Oracle/Sun JDK 6 或 7）、Apache Ant 和 Python v2.6 或更高版本。

构建

让我们构建 OpenCV

git clone git://github.com/opencv/opencv.git
cd opencv
git checkout 2.4
mkdir build
cd build

生成 Makefile 或 MS Visual Studio* 解决方案，或您在系统中用于构建可执行文件的任何工具

cmake -DBUILD_SHARED_LIBS=OFF ..

或者

cmake -DBUILD_SHARED_LIBS=OFF -G "Visual Studio 10" ..

注意: 当 OpenCV 构建为一组静态库（-DBUILD_SHARED_LIBS=OFF 选项）时，Java 绑定动态库就足够了，即不依赖于其他 OpenCV 库，而是包含所有 OpenCV 代码。

检查 CMake 的输出，并确保 java 是“要构建的”模块之一。如果不是，则可能缺少依赖项。您应该通过查看 CMake 输出中任何未找到的与 Java 相关的工具并安装它们来进行故障排除。

注意: 如果 CMake 找不到系统中的 Java，请在运行它之前使用已安装 JDK 的路径设置 JAVA_HOME 环境变量。例如：
export JAVA_HOME=/usr/lib/jvm/java-6-oracle

cmake -DBUILD_SHARED_LIBS=OFF ..

现在开始构建

make -j8

或者

msbuild /m OpenCV.sln /t:Build /p:Configuration=Release /v:m

除此之外，这还会创建一个包含 Java 接口的 jar 文件 (bin/opencv-244.jar) 和一个包含 Java 绑定和所有 OpenCV 内容的本地动态库 (lib/libopencv_java244.so 或 bin/Release/opencv_java244.dll)。我们稍后将使用这些文件。

使用 Ant 的 Java 示例

注意: OpenCV 库在 opencv/samples/java/ant 文件夹中提供了此示例。

创建一个文件夹来开发此示例应用程序。
在此文件夹中，使用任何文本编辑器创建包含以下内容的 build.xml 文件
<project name="SimpleSample" basedir="." default="rebuild-run">

<property name="src.dir" value="src"/>

<property name="lib.dir" value="${ocvJarDir}"/>

<path id="classpath">

<fileset dir="${lib.dir}" includes="**/*.jar"/>

</path>

<property name="build.dir" value="build"/>

<property name="classes.dir" value="${build.dir}/classes"/>

<property name="jar.dir" value="${build.dir}/jar"/>

<property name="main-class" value="${ant.project.name}"/>

<target name="clean">

<delete dir="${build.dir}"/>

</target>

<target name="compile">

<mkdir dir="${classes.dir}"/>

<javac includeantruntime="false" srcdir="${src.dir}" destdir="${classes.dir}" classpathref="classpath"/>

</target>

<target name="jar" depends="compile">

<mkdir dir="${jar.dir}"/>

<jar destfile="${jar.dir}/${ant.project.name}.jar" basedir="${classes.dir}">

<manifest>

<attribute name="Main-Class" value="${main-class}"/>

</manifest>

</jar>

</target>

<target name="run" depends="jar">

<java fork="true" classname="${main-class}">

<sysproperty key="java.library.path" path="${ocvLibDir}"/>

<classpath>

<path refid="classpath"/>

<path location="${jar.dir}/${ant.project.name}.jar"/>

</classpath>

</java>

</target>

<target name="rebuild" depends="clean,jar"/>

<target name="rebuild-run" depends="clean,run"/>

</project>

注意
此XML文件可重复用于构建其他Java应用程序。它在第3-12行描述了常见的文件夹结构，以及编译和运行应用程序的常见目标。重复使用此XML时，请勿忘记修改第1行的项目名称，该名称也是主类名（第14行）。OpenCV jar和jni库的路径作为参数提供（第5行的"${ocvJarDir}"和第37行的"${ocvLibDir}"），但您可以根据需要硬编码这些路径。有关其构建文件格式的详细说明，请参阅Ant文档。
在build.xml文件旁边创建一个src文件夹，并在其中创建一个SimpleSample.java文件。
将以下Java代码放入SimpleSample.java文件
import org.opencv.core.Core;

import org.opencv.core.Mat;

import org.opencv.core.CvType;

import org.opencv.core.Scalar;

class SimpleSample {

static{ System.loadLibrary(Core.NATIVE_LIBRARY_NAME); }

public static void main(String[] args) {

System.out.println("Welcome to OpenCV " + Core.VERSION);

Mat m = new Mat(5, 10, CvType.CV_8UC1, new Scalar(0));

System.out.println("OpenCV Mat: " + m);

Mat mr1 = m.row(1);

mr1.setTo(new Scalar(1));

Mat mc5 = m.col(5);

mc5.setTo(new Scalar(5));

System.out.println("OpenCV Mat data:\n" + m.dump());

}

}

main
int main(int argc, char *argv[])
定义 highgui_qt.cpp:3
在包含build.xml的文件夹的控制台中运行以下命令
ant -DocvJarDir=path/to/dir/containing/opencv-244.jar -DocvLibDir=path/to/dir/containing/opencv_java244/native/library

例如
ant -DocvJarDir=X:\opencv-2.4.4\bin -DocvLibDir=X:\opencv-2.4.4\bin\Release

该命令应该启动[重新]构建并运行示例。您应该在屏幕上看到类似这样的内容

Java和Scala的SBT项目

现在，我们将使用SBT创建一个简单的Java应用程序。这作为对不熟悉此构建工具的人的简要介绍。我们使用SBT是因为它特别简单且功能强大。

首先，使用其网站上的说明下载并安装SBT。

接下来，导航到您希望应用程序源代码所在的新的目录（在opencv目录之外）。让我们称之为“JavaSample”并为其创建一个目录

cd <opencv目录之外的某个位置>

mkdir JavaSample

现在我们将创建必要的文件夹和SBT项目

cd JavaSample
mkdir -p src/main/java # 这是SBT期望找到Java源代码的地方
mkdir project # 这是构建定义所在的地方

现在在您喜欢的编辑器中打开project/build.scala并粘贴以下内容。它定义了您的项目

import sbt._
import Keys._
 
object JavaSampleBuild extends Build {
def scalaSettings = Seq(
scalaVersion := "2.10.0",
scalacOptions ++= Seq(
"-optimize",
"-unchecked",
"-deprecation"
    )
  )
 
def buildSettings =
Project.defaultSettings ++
scalaSettings
 
lazy val root = {
val settings = buildSettings ++ Seq(name := "JavaSample")
Project(id = "JavaSample", base = file("."), settings = settings)
  }
}

现在编辑project/plugins.sbt并粘贴以下内容。这将启用Eclipse项目的自动生成

addSbtPlugin("com.typesafe.sbteclipse" % "sbteclipse-plugin" % "2.1.0")

现在从JavaSample根目录运行sbt，并在sbt内部运行eclipse以生成eclipse项目

sbt # 启动sbt控制台

eclipse # 在sbt控制台中运行“eclipse”

您应该会看到类似这样的内容

您现在可以使用“导入... -> 将现有项目导入工作区”将SBT项目导入Eclipse。您是否实际执行此操作对于本指南是可选的；我们将使用SBT构建项目，因此如果您选择使用Eclipse，它将仅用作文本编辑器。

为了测试一切是否正常工作，请创建一个简单的“Hello OpenCV”应用程序。为此，请创建一个包含以下内容的文件src/main/java/HelloOpenCV.java

public class HelloOpenCV {
  public static void main(String[] args) {
System.out.println("Hello, OpenCV");
 }

}

现在从sbt控制台执行run，或者更简洁地说，从命令行运行sbt run

sbt run

您应该会看到类似这样的内容

运行SBT示例

现在，我们将使用OpenCV创建一个简单的面部检测应用程序。

首先，创建一个lib/文件夹并将OpenCV jar复制到其中。默认情况下，SBT会将lib文件夹中的jar添加到Java库搜索路径中。您可以选择重新运行sbt eclipse来更新您的Eclipse项目。

mkdir lib
cp <opencv_dir>/build/bin/opencv_<version>.jar lib/
sbt eclipse

接下来，创建目录src/main/resources并将此Lena图像下载到其中

确保它被称为"lena.png"。资源目录中的项目在运行时可供Java应用程序使用。

接下来，将lbpcascade_frontalface.xml从opencv/data/lbpcascades/复制到resources目录

cp <opencv_dir>/data/lbpcascades/lbpcascade_frontalface.xml src/main/resources/

现在修改src/main/java/HelloOpenCV.java，使其包含以下Java代码

import org.opencv.core.Core;
import org.opencv.core.Mat;
import org.opencv.core.MatOfRect;
import org.opencv.core.Point;
import org.opencv.core.Rect;
import org.opencv.core.Scalar;
import org.opencv.imgcodecs.Imgcodecs;
import org.opencv.objdetect.CascadeClassifier;
 
//
// 检测图像中的面部，在其周围绘制方框，并将结果
// 写入“faceDetection.png”。
//
class DetectFaceDemo {
  public void run() {
System.out.println("\n运行 DetectFaceDemo");
 
    // 从资源目录中的级联文件中创建一个面部检测器。
    //
CascadeClassifier faceDetector = new CascadeClassifier(getClass().getResource("/lbpcascade_frontalface.xml").getPath());
Mat image = Imgcodecs.imread(getClass().getResource("/lena.png").getPath());
 
    // 检测图像中的面部。
    // MatOfRect 是 Rect 的特殊容器类。
MatOfRect faceDetections = new MatOfRect();
faceDetector.detectMultiScale(image, faceDetections);
 
System.out.println(String.format("检测到 %s 个面部", faceDetections.toArray().length));
 
    // 在每个面部周围绘制边界框。
    for (Rect rect : faceDetections.toArray()) {
Imgproc.rectangle(image, new Point(rect.x, rect.y), new Point(rect.x + rect.width, rect.y + rect.height), new Scalar(0, 255, 0));
    }
 
    // 保存可视化检测结果。
String filename = "faceDetection.png";
System.out.println(String.format("正在写入 %s", filename));
Imgcodecs.imwrite(filename, image);
  }
}
 
public class HelloOpenCV {
  public static void main(String[] args) {
System.out.println("Hello, OpenCV");
 
    // 加载原生库。
System.loadLibrary(Core.NATIVE_LIBRARY_NAME);
    new DetectFaceDemo().run();
  }
}

请注意对 System.loadLibrary(Core.NATIVE_LIBRARY_NAME) 的调用。此命令必须在使用任何原生 OpenCV 方法之前，在每个 Java 进程中精确执行一次。如果不调用它，您将收到 UnsatisfiedLink 错误。如果尝试在 OpenCV 已加载后加载它，您也将收到错误。

现在使用 `sbt run` 运行人脸检测应用程序

sbt run

您应该会看到类似这样的内容

它还应该将以下图像写入 faceDetection.png

完成了！现在您已经拥有一个使用 OpenCV 的 Java 示例应用程序，因此您可以开始自己的工作了。祝您一切顺利，生活愉快！