Skip to main content

jaxb2-maven-plugin to generate java code from XSD schema

In this tutorial I will show how to generate the Java source code from XSD schema. I will use jaxb2-maven-plugin to generate the code using XSD file which will be declared in pom.xml to make it part of build, so when maven build is executed it will generate the java code using XSD. Class generation can be controlled in plugin configuration.

Maven changes (pom.xml)

Include below plugin in your pom.xml. Here we have done some configuration under configuration section as given below.
schemaDirectory: This is the directory where I keep my schema (XSD file).
outputDirectory: This is the java source location where I want to generate the Java files. If it is not given then by default it will be generate inside target folder.
clearOutputDir: If this property is true then it will generate the classes on each build otherwise it will generate only if output directory is empty.
<plugin>
 <groupId>org.codehaus.mojo</groupId>
 <artifactId>jaxb2-maven-plugin</artifactId>
 <version>1.6</version>
 <executions>
    <execution>
     <id>xjc</id>
     <goals>
        <goal>xjc</goal>
     </goals>
    </execution>
 </executions>
 <configuration>
    <schemaDirectory>${project.basedir}/src/main/resources/schema</schemaDirectory>
    <outputDirectory>${project.basedir}/src/main/java</outputDirectory>
    <clearOutputDir>false</clearOutputDir>
 </configuration>
</plugin>

XSD Schema (employee.xsd)

Below is the XSD schema which will be used to generate the Java class.
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://myexample.com/employee"
targetNamespace="http://myexample.com/employee">
 <xs:complexType name="employee">
  <xs:sequence>
   <xs:element name="name" type="xs:string"/>
   <xs:element name="age" type="xs:int"/>
   <xs:element name="organization" type="xs:string"/>
   <xs:element name="salary" type="xs:decimal"/>
  </xs:sequence>
 </xs:complexType>
</xs:schema>
XSD location is as given below in my application.
xsd location

Generating Java classes

After setting up the above code and configuration, we can run the maven build by executing "men clean install". It will generate the Java classes using the XSD schema. Below is the generated code package structure after the build execution.
generated classes

Below is the snap of code from generated classes. Getters/Setters are also generated but not included in example.
  • Employee.java
  • @XmlAccessorType(XmlAccessType.FIELD)
     @XmlType(name = "employee", propOrder = {
         "name",
         "age",
         "organization",
         "salary"
     })
    
     public class Employee {
         @XmlElement(required = true)
         protected String name;
    
         protected int age;
    
         @XmlElement(required = true)
         protected String organization;
    
         @XmlElement(required = true)
         protected BigDecimal salary;
    
  • ObjectFactory.java
  • @XmlRegistry
     public class ObjectFactory {
         /**
          * Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: com.myexample.employee
          * 
          */
         public ObjectFactory() {
    
         } 
    
         /**
          * Create an instance of {@link Employee }
          * 
          */
         public Employee createEmployee() {
             return new Employee();
         } 
     }
    
  • package-info.java
  • @javax.xml.bind.annotation.XmlSchema(namespace = "http://myexample.com/employee")
    package com.myexample.employee;
    
That's all. Usually you may have a need to generate the class this way when you are creating some SOAP service client or you can use it to just create the Java POJO classes also.

You may be interested in my other post on generating Java classes using annotation processor.
https://www.thetechnojournals.com/2019/12/annotation-processor-to-generate-dto.html

Comments

Popular Posts

SpringBoot - @ConditionalOnProperty example for conditional bean initialization

@ConditionalOnProperty annotation is used to check if specified property available in the environment or it matches some specific value so it can control the execution of some part of code like bean creation. It may be useful in many cases for example enable/disable service if specific property is available. Below are the attributes which can be used for property check.
havingValue - Provide the value which need to check against specified property otherwise it will check that value should not be false.matchIfMissing - If true it will match the condition and execute the annotated code when property itself is not available in environment.name - Name of the property to be tested. If you want to test single property then you can directly put the property name as string like "property.name" and if you have multiple properties to test then you can put the names like {"prop.name1","prop.name2"}prefix - It can be use when you want to apply some prefix to all prop…

Asynchronous REST service implementation in Spring boot

In this tutorial we will see how to create an asynchronous REST service endpoint using Spring boot application.
Asynchronous service works in a way that it will not block the client request and do the processing in separate thread. When work is complete the response returned to the client so our service will be able to handle more client requests at the same time, compare to synchronous processing model.
Let's understand how it is working in synchronous mode. In such server/client application at server side it has a pool of threads which are serving the request. If a request received by a thread then it will be blocked until it send the response back to client. In this case if processing doesn't take much time it will be able to process it quickly and accept other client requests but there could be one situation when all threads are busy and not able to accept the new client requests.

To overcome of such problems, asynchronous processing model introduced for REST services. In…

Entity to DTO conversion in Java using Jackson

It's very common to have the DTO class for a given entity in any application. When persisting data, we use entity objects and when we need to provide the data to end user/application we use DTO class. Due to this we may need to have similar properties on DTO class as we have in our Entity class and to share the data we populate DTO objects using entity objects. To do this we may need to call getter on entity and then setter on DTO for the same data which increases number of code line. Also if number of DTOs are high then we need to write lot of code to just get and set the values or vice-versa.
To overcome this problem we are going to use Jackson API and will see how to do it with minimal code only.
Maven dependency <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.9</version> </dependency> Entity class Below is our ent…

Web scraper using JSoup and Spring Boot

What is webscraping Webscraping is a technique to extract or pull the data from a website to gather required information by parsing the HTML source of their websites, such as articles from news or books site, products information from online shopping sites or course information from education sites. There are many organisations who uses web scraper to provide the best experience to their customers, for example extract the price for a smartphone from multiple online websites and show their customers the best and cheap product URL.
We will learn here how to code a web scraper by developing a simple new scraper service.
News scraper News scraper is used to extract the news articles or other related contents from a news site. Here we are going to create a web scraper application to pull the articles from news site.
Below are the operations provided by our news scraper service.
List all the authorsSearch articles by author nameSearch articles by article titleSearch articles by article desc…