Overview

JACOB is built on windows machines using ANT, most commonly from inside of Eclipse. The main steps for getting a working Jacob build are: (JACOB是使用ANT在Windows计算机上构建的，通常是在Eclipse内部。获得有效的Jacob版本的主要步骤是：)

1. Check out the source code or unpack the source zip file from sourceforge(签出源代码或从sourceforge解压缩源zip文件)
2. Install the Development Environment(安装开发环境)
3. Configure the build by creating a compilation_tools.properties file.(通过创建compilation_tools.properties文件来配置构建。)
4. Run Eclipse and load the project into eclipse(运行Eclipse并将项目加载到eclipse中)
5. Open the build.xml file in Eclipse and run the default ant target (在Eclipse中打开build.xml文件并运行默认的ant目标)

Repository Organization

Unpack the source archive zip file or check the files out of CVS into d:\jacob or some other familiar place. Source Java and JNI files are located in separate packages from the unit tests and the samples. (解压缩源归档zip文件或将文件从CVS中检出到d：\ jacob或其他熟悉的地方。源Java和JNI文件与单元测试和示例位于单独的软件包中。)

• docs: documentation (docs：文档)
• jni: c++ code (jni：c ++代码)
• lib: libraries needed to compile unit tests (lib：编译单元测试所需的库)
• release: a directory built by the ant script where jacob is constructed (release：由ant脚本构建的目录，在该目录中构造了jacob)
• samples: sample programs (示例：示例程序)
• src: Jacob Java source files (src：Jacob Java源文件)
• unittest: JUnit 3.8.1 unit test programs. Run from the test target in build.xml (unittest：JUnit 3.8.1单元测试程序。从build.xml中的测试目标运行)
• vstudio: some out of date VC++ project files (vstudio：一些过时的VC ++项目文件)
• bulid.xml: the ant build script. It can be run from inside Eclipse (build.xml：蚂蚁构建脚本。可以从Eclipse内部运行)

The Servlet examples that required j2ee libraries to compile have temporarily been removed. (暂时删除了需要j2ee库进行编译的Servlet示例。)

Development Environment

The simplest build environment includes MS Visual Studio 10.0 (Studio 2010), Eclipse 3.3 with the C/C++ module and JDK 1.6. In that situation, you would just create the (最简单的构建环境包括MS Visual Studio 10.0（Studio 2010），带有C / C ++模块的Eclipse 3.3和JDK 1.6。在这种情况下，您只需创建)

using the example at the top of build.xml as a template. (使用build.xml顶部的示例作为模板。)

• Microsoft Visual Studio 2013 and it's included library. (to C:\ProgramFiles (X86) in my case) (Microsoft Visual Studio 2013及其随附的库。 （以我的情况为C：\ ProgramFiles（X86））)
• Eclipse from www.eclipse.org as the Java IDE. (来自www.eclipse.org的Eclipse作为Java IDE。)
• Eclipse C/C++ plugin can be used for C coding in place of VC++ IDE. (Eclipse C / C ++插件可以代替VC ++ IDE用于C编码。)
• Java JDK 1.6 , latest available (Java JDK 1.6，最新可用)
• Install the V7.1A libraries that originally came with VS2010 (安装VS2010最初随附的V7.1A库)

Microsoft Visual Studio 13 supports 64 bit builds. so no additional tools are required.(Microsoft Visual Studio 13支持64位版本。因此不需要其他工具。)

Microsoft changed the location of the windows sdk (formerly known as platform sdk) after VC 8.0. https://en.wikipedia.org/wiki/Microsoft_Windows_SDK (Microsoft在VC 8.0之后更改了Windows SDK的位置（以前称为Platform SDK）。 https://zh.wikipedia.org/wiki/Microsoft_Windows_SDK)

Build Process

The build process is based on ANT. You can run ANT from inside of eclipse or from the command line. Running from inside eclipse means you don't have any installation, pathing or configuration to do. You can just open the xml, select the target in the "Outline" pane, right mouse and then "run as ant" on the selected target. (构建过程基于ANT。您可以从eclipse内部或从命令行运行ANT。从eclipse内部运行意味着您无需执行任何安装，路径或配置。您可以打开xml，在“概述”窗格中选择目标，右键单击鼠标，然后在所选目标上“以蚂蚁身份运行”。)

The ant process is driven off of a configuration file named compilation_tools.properties that describes the locations of the JDK and Microsoft C++ tools. The build.xml file in the root directory contains examples of the contents of this file. (ant进程是从一个名为configuration_tools.properties的配置文件开始的，该文件描述了JDK和Microsoft C ++工具的位置。根目录中的build.xml文件包含此文件内容的示例。)

There are two main ant targets. (有两个主要的蚂蚁目标。)

• "default" executes the following steps when using the default target.
  • Build the Java code (构建Java代码)
  • Build the jni code (编译jni代码)
  • create the dll (创建DLL)
  • create jar file (创建jar文件)
  (使用默认目标时，“默认”执行以下步骤。生成Java代码生成jni代码创建dll创建jar文件)
• "packageRelease" runs the above listed steps and then
  • builds the javadoc (构建javadoc)
  • builds a source zip (构建一个源zip)
  • builds a binary zip with the javadoc (使用javadoc构建二进制zip)
  (“ packageRelease”运行上面列出的步骤，然后构建javadoc，构建源zip，并使用javadoc构建二进制zip。)

Eclipse Java IDE

Eclipse users have to do some minor tweaks to their project if they want to use the integrated build process. This is because the unit tests are files located in the "unittest" directory while the project source files themselves are in "src" the root directory. By default, eclipse will add the entire project as source. This messes up the package naming. In addition, the build directory should be set to be the same place the ANT build puts the compiled java classes. A couple small tweaks to the build path fix these problems: (Eclipse用户如果要使用集成的构建过程，则必须对其项目进行一些小的调整。这是因为单元测试是位于“ unittest”目录中的文件，而项目源文件本身位于根目录“ src”中。默认情况下，eclipse会将整个项目添加为源。这弄乱了程序包的命名。此外，应将构建目录设置为与ANT构建放置已编译的Java类相同的位置。对构建路径进行了一些小调整，以解决以下问题：)

Open up the project properties and go to the "Java Build Path" properties panel. (打开项目属性，然后转到“ Java Build Path”属性面板。)

• Remove the root of the project from the build path(从构建路径中删除项目的根目录)
• Add folders samples, src and unittest to the build path in the Source tab.(将文件夹样本，src和unittest添加到“源”选项卡中的构建路径。)
• Exclude *.txt from each of the newly added folders. (从每个新添加的文件夹中排除* .txt。)
• Set the default build output directory to jacob-project/release/java(将默认的构建输出目录设置为jacob-project / release / java)

Troubleshooting Build Problems (解决构建问题)

• Symptom: Build Failed can't find javac compiler. JAVA_HOME does not point to the JDK Problem: The java library is pointed at a jre insted of the jdk. Update Project..Properties..Java Build Path to point at the JDK (症状：Build Failed找不到javac编译器。 JAVA_HOME不指向JDK问题：Java库指向由jdk插入的jre。更新Project..Properties..Java构建路径以指向JDK)
• Symptom: The jar is built but no dlls were compiled.

  Problem: compilation_tools.properties does not have the correct location for the Microsoft tools.(问题：compilation_tools.properties没有Microsoft工具的正确位置。)

  (症状：构建了jar，但未编译任何dll。问题：compilation_tools.properties没有Microsoft工具的正确位置。)
• Sympton: Can't find jni.h or can't find C++ compiler

  Problem: compilation_tools.properties configured incorrectly. Either paths are wrong or the separator is wrong. It requires two backslashes for a separator.(问题：compilation_tools.properties配置不正确。路径错误或分隔符错误。分隔符需要两个反斜杠。)

  (症状：找不到jni.h或找不到C ++编译器问题：compilation_tools.properties配置不正确。路径错误或分隔符错误。分隔符需要两个反斜杠。)
• Symptom: Ant fails with the message Could not create task or type of type: junit..

  Problem: junit.jar must be copied from this project to the $ANT_HOME/lib directory.(问题：必须将junit.jar从该项目复制到$ ANT_HOME / lib目录。)

  (症状：Ant失败，并显示消息无法创建任务或类型类型：junit。问题：junit.jar必须从该项目复制到$ ANT_HOME / lib目录。)

Running Samples and Tests

Samples and JUnit test programs can be found in the source jar or in CVS. The programs can be run from a bat file or from inside the Eclipse IDE. The java library path variable must be set to include the directory the jacob.dll is in. The simplest way to do that is to add it as a command line option. The following assume that your jacob development area is located in c:\dev\jacob: (样本和JUnit测试程序可以在源jar或CVS中找到。这些程序可以从bat文件运行，也可以从Eclipse IDE内部运行。必须将Java库路径变量设置为包括jacob.dll所在的目录。最简单的方法是将其添加为命令行选项。以下假设您的jacob开发区域位于c：\ dev \ jacob中：)

	-Djava.library.path=c:/dev/jacob/release/x86 
	-Dcom.jacob.autogc=false 
	-Dcom.jacob.debug=false 
	-Xcheck:jni

JUnit test programs can be individually run from inside eclipse or en-masse via the ant test target. Last Modified 10/2008 1.15 (JUnit测试程序可以通过ant测试目标从eclipse或en-masse内部单独运行。上次修改时间10/2008 1.15)