![](/img/trans.png)
[英]Generating hashCode() and equals() when creating Java classes using Mojo Jaxb2 maven plugin
[英]Add toString, hashCode, equals while generating JAXB classes in Java
我正在尝试使用 Java 以编程方式从 XSD 文件生成 JAXB 类。 我使用以下代码片段来实现这一点:
....
import java.io.File;
import java.io.IOException;
import org.xml.sax.InputSource;
import com.sun.codemodel.JCodeModel;
import com.sun.tools.xjc.api.S2JJAXBModel;
import com.sun.tools.xjc.api.SchemaCompiler;
import com.sun.tools.xjc.api.XJC;
....
....
public static void generateJaxb(String schemaPath,
String outputDirectory,
String packageName) throws DataLoadingException
{
try {
// Setup schema compiler
SchemaCompiler sc = XJC.createSchemaCompiler();
sc.forcePackageName(packageName);
// Setup SAX InputSource
File schemaFile = new File(schemaPath);
InputSource is = new InputSource(schemaFile.toURI().toString());
// Parse & build
sc.parseSchema(is);
S2JJAXBModel model = sc.bind();
JCodeModel jCodeModel = model.generateCode(null, null);
jCodeModel.build(new File(outputDirectory));
} catch (IOException exec) {
LOGGER.error("Error while generating JAXB classes: " + exec);
}
}
生成的类只包含字段的getter
方法。 但是,我还想包括hashCode
、 equals
和setter
方法。 在生成代码时如何做到这一点?
在 GitHub 网站上,您会找到JAXB2 Basics 项目,它提供了一组通用的JAXB
实用程序插件,其中包括 4 个应该解决您要实现的目标:
还有其他可用的插件涵盖了Java
域对象的类似常见方面。
从XML Schema
配置的角度来看,您将添加如下所示的引用:
<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
xmlns:basic="http://jaxb2-commons.dev.java.net/basic"
xmlns:equals="http://jaxb2-commons.dev.java.net/basic/equals"
xmlns:hashCode="http://jaxb2-commons.dev.java.net/basic/hashCode"
xmlns:toString="http://jaxb2-commons.dev.java.net/basic/toString"
jaxb:extensionBindingPrefixes="basic equals hashCode toString">
<!-- ... -->
</xs:schema>
还有其他可用选项,例如定义在生成equals( that )
实现、 toString()
实现等时应忽略的对象属性。
从Java
角度来看,插件通常让生成的类实现一个interface
; 例如,包含equals( that )
实现的生成类将实现 [Equals][6] 接口。
插件使用的设计方法通常会产生两种实现方式:
equals( that )
方法(使用Equals Plugin
)。locator
和strategy
参数,允许您实现自定义处理(如果您愿意)。 对于这些,您将看到一个方法签名,例如: equals( thisLocator, thatLocator, that, strategy)
。从运行时的角度来看,您必须包含JAXB2 Basics Runtime jar 并提供选项参数,例如: -Xequals
、 -XhashCode
或-XtoString
。 提供了使用Ant
和Maven
的 JAXB2 基础知识的示例,如果您使用其中任何一个来执行构建,则JAXB2 基础知识用户指南中提供了更多与构建相关的详细信息。
更新下面的答案是不正确的。 我被界面误导了,目前generateCode
真的没有对插件做任何事情。 正如@Sidola 指出的那样,您应该改用SchemaCompiler
。
除了@SeanMickey 的回答之外,我还将解决代码生成问题。
org.jvnet.jaxb2_commons.plugin.tostring.ToStringPlugin
org.jvnet.jaxb2_commons.plugin.equals.EqualsPlugin
org.jvnet.jaxb2_commons.plugin.hashcode.HashCodePlugin
org.jvnet.jaxb2_commons.plugin.setters.SettersPlugin
model.generateCode(plugins errorListener)
作为第一个参数传递给model.generateCode(plugins errorListener)
。顺便问一下,为什么要以编程方式生成代码?
对我来说,最简单的方法是使用JAXB2 Basics Plugins :
<dependencies>
<dependency>
<groupId>org.jvnet.jaxb2_commons</groupId>
<artifactId>jaxb2-basics</artifactId>
<version>0.11.1</version>
</dependency>
<plugin>
<groupId>org.jvnet.jaxb2.maven2</groupId>
<artifactId>maven-jaxb2-plugin</artifactId>
<version>0.14.0</version>
<executions>
<execution>
<goals>
<goal>generate</goal>
</goals>
<configuration>
<schemaDirectory>src/main/resources</schemaDirectory>
<generateDirectory>target/generated-sources</generateDirectory>
<generatePackage>my.package</generatePackage>
</configuration>
</execution>
</executions>
<configuration>
<extension>true</extension>
<args>
<arg>-XtoString</arg>
<arg>-Xequals</arg>
<arg>-XhashCode</arg>
</args>
<plugins>
<plugin>
<groupId>org.jvnet.jaxb2_commons</groupId>
<artifactId>jaxb2-basics</artifactId>
<version>0.11.1</version>
</plugin>
</plugins>
</configuration>
</plugin>
在mvn clean install
生成的类将如下所示:
package my.package
public class MyClass implements Equals2, HashCode2, ToString2 {
}
来源: https : //github.com/highsource/jaxb2-basics/wiki/Using-JAXB2-Basics-Plugins
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.