在Gradle中使用jaxb的xjc外掛

黃博文發表於2014-08-30

jaxb,全稱為Java Architecture for Xml Binding,是一種將java物件與xml建立起對映的技術。其主要提供兩個功能,一是將java物件對映為xml,二是將xml對映為java物件。JAXB有1.0版和2.0版。2.0版對應的JSR(Java specification request, java規格要求)是JSR 222。jaxb中的xjc工具能夠將XML Schema轉換為對應的java類。支援的XML型別包括XML DTD,XSD以及WSDL。而schemagen工具則可以將具有相應annotation標記的java類轉換為XML結構。

ant指令碼有xjc外掛來實現對xml schema檔案轉換為java類的工作。而由於ant任務是gradle中的一等公民,所以我們可以直接在gradle指令碼中使用ant的xjc外掛來實現對xml schema和java類的對映。以下程式碼演示瞭如何將xsd格式和wsdl格式的xml轉換為具體的java類。

build.gradle
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
configurations {
    jaxb
}

dependencies {
    jaxb 'com.sun.xml.bind:jaxb-impl:2.2.7'
    jaxb 'com.sun.xml.bind:jaxb-xjc:2.2.7'
}

ext {
    generatedSourceDir = 'src/main/generated'
}


task jaxb {

    doLast {
        file(generatedSourceDir).mkdirs()

        ant.taskdef(name: 'xjc', classname: 'com.sun.tools.xjc.XJCTask', classpath: configurations.jaxb.asPath)

        ant.xjc(destdir: generatedSourceDir,
                package: 'jaxb.ws.ship',
                schema: 'schema/shiporder.xsd'
        )

        ant.xjc(destdir: generatedSourceDir,
                package: 'jaxb.ws.hello',
                schema: 'schema/weather.wsdl'
        ) {
            arg(value: '-wsdl')
        }

    }
}

clean {
    ant.delete(dir: generatedSourceDir)
}

這裡實現了將xsd和wsdl格式的xml文件轉換為具體的java類。注意一點是如果wsdl中的schema過於簡單,可能不會有具體的類生成。另外附上使用的示例檔案。

shiporder.xsd檔案如下:

shiporder.xsd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

    <xs:element name="shiporder">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="orderperson" type="xs:string"/>
                <xs:element name="shipto">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="name" type="xs:string"/>
                            <xs:element name="address" type="xs:string"/>
                            <xs:element name="city" type="xs:string"/>
                            <xs:element name="country" type="xs:string"/>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
                <xs:element name="item" maxOccurs="unbounded">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="title" type="xs:string"/>
                            <xs:element name="note" type="xs:string" minOccurs="0"/>
                            <xs:element name="quantity" type="xs:positiveInteger"/>
                            <xs:element name="price" type="xs:decimal"/>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
            <xs:attribute name="orderid" type="xs:string" use="required"/>
        </xs:complexType>
    </xs:element>

</xs:schema>

weather.wsdl檔案內容如下:

weather.wsdl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<?xml version="1.0" encoding="utf-8"?>
<wsdl:definitions xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:tns="http://www.webserviceX.NET" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" targetNamespace="http://www.webserviceX.NET" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
    <wsdl:types>
        <s:schema elementFormDefault="qualified" targetNamespace="http://www.webserviceX.NET">
            <s:element name="GetWeather">
                <s:complexType>
                    <s:sequence>
                        <s:element minOccurs="0" maxOccurs="1" name="CityName" type="s:string" />
                        <s:element minOccurs="0" maxOccurs="1" name="CountryName" type="s:string" />
                    </s:sequence>
                </s:complexType>
            </s:element>
            <s:element name="GetWeatherResponse">
                <s:complexType>
                    <s:sequence>
                        <s:element minOccurs="0" maxOccurs="1" name="GetWeatherResult" type="s:string" />
                    </s:sequence>
                </s:complexType>
            </s:element>
            <s:element name="GetCitiesByCountry">
                <s:complexType>
                    <s:sequence>
                        <s:element minOccurs="0" maxOccurs="1" name="CountryName" type="s:string" />
                    </s:sequence>
                </s:complexType>
            </s:element>
            <s:element name="GetCitiesByCountryResponse">
                <s:complexType>
                    <s:sequence>
                        <s:element minOccurs="0" maxOccurs="1" name="GetCitiesByCountryResult" type="s:string" />
                    </s:sequence>
                </s:complexType>
            </s:element>
            <s:element name="string" nillable="true" type="s:string" />
        </s:schema>
    </wsdl:types>
    <wsdl:message name="GetWeatherSoapIn">
        <wsdl:part name="parameters" element="tns:GetWeather" />
    </wsdl:message>
    <wsdl:message name="GetWeatherSoapOut">
        <wsdl:part name="parameters" element="tns:GetWeatherResponse" />
    </wsdl:message>
    <wsdl:message name="GetCitiesByCountrySoapIn">
        <wsdl:part name="parameters" element="tns:GetCitiesByCountry" />
    </wsdl:message>
    <wsdl:message name="GetCitiesByCountrySoapOut">
        <wsdl:part name="parameters" element="tns:GetCitiesByCountryResponse" />
    </wsdl:message>
    <wsdl:message name="GetWeatherHttpGetIn">
        <wsdl:part name="CityName" type="s:string" />
        <wsdl:part name="CountryName" type="s:string" />
    </wsdl:message>
    <wsdl:message name="GetWeatherHttpGetOut">
        <wsdl:part name="Body" element="tns:string" />
    </wsdl:message>
    <wsdl:message name="GetCitiesByCountryHttpGetIn">
        <wsdl:part name="CountryName" type="s:string" />
    </wsdl:message>
    <wsdl:message name="GetCitiesByCountryHttpGetOut">
        <wsdl:part name="Body" element="tns:string" />
    </wsdl:message>
    <wsdl:message name="GetWeatherHttpPostIn">
        <wsdl:part name="CityName" type="s:string" />
        <wsdl:part name="CountryName" type="s:string" />
    </wsdl:message>
    <wsdl:message name="GetWeatherHttpPostOut">
        <wsdl:part name="Body" element="tns:string" />
    </wsdl:message>
    <wsdl:message name="GetCitiesByCountryHttpPostIn">
        <wsdl:part name="CountryName" type="s:string" />
    </wsdl:message>
    <wsdl:message name="GetCitiesByCountryHttpPostOut">
        <wsdl:part name="Body" element="tns:string" />
    </wsdl:message>
    <wsdl:portType name="GlobalWeatherSoap">
        <wsdl:operation name="GetWeather">
            <wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">Get weather report for all major cities around the world.</wsdl:documentation>
            <wsdl:input message="tns:GetWeatherSoapIn" />
            <wsdl:output message="tns:GetWeatherSoapOut" />
        </wsdl:operation>
        <wsdl:operation name="GetCitiesByCountry">
            <wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">Get all major cities by country name(full / part).</wsdl:documentation>
            <wsdl:input message="tns:GetCitiesByCountrySoapIn" />
            <wsdl:output message="tns:GetCitiesByCountrySoapOut" />
        </wsdl:operation>
    </wsdl:portType>
    <wsdl:portType name="GlobalWeatherHttpGet">
        <wsdl:operation name="GetWeather">
            <wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">Get weather report for all major cities around the world.</wsdl:documentation>
            <wsdl:input message="tns:GetWeatherHttpGetIn" />
            <wsdl:output message="tns:GetWeatherHttpGetOut" />
        </wsdl:operation>
        <wsdl:operation name="GetCitiesByCountry">
            <wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">Get all major cities by country name(full / part).</wsdl:documentation>
            <wsdl:input message="tns:GetCitiesByCountryHttpGetIn" />
            <wsdl:output message="tns:GetCitiesByCountryHttpGetOut" />
        </wsdl:operation>
    </wsdl:portType>
    <wsdl:portType name="GlobalWeatherHttpPost">
        <wsdl:operation name="GetWeather">
            <wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">Get weather report for all major cities around the world.</wsdl:documentation>
            <wsdl:input message="tns:GetWeatherHttpPostIn" />
            <wsdl:output message="tns:GetWeatherHttpPostOut" />
        </wsdl:operation>
        <wsdl:operation name="GetCitiesByCountry">
            <wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">Get all major cities by country name(full / part).</wsdl:documentation>
            <wsdl:input message="tns:GetCitiesByCountryHttpPostIn" />
            <wsdl:output message="tns:GetCitiesByCountryHttpPostOut" />
        </wsdl:operation>
    </wsdl:portType>
    <wsdl:binding name="GlobalWeatherSoap" type="tns:GlobalWeatherSoap">
        <soap:binding transport="http://schemas.xmlsoap.org/soap/http" />
        <wsdl:operation name="GetWeather">
            <soap:operation soapAction="http://www.webserviceX.NET/GetWeather" style="document" />
            <wsdl:input>
                <soap:body use="literal" />
            </wsdl:input>
            <wsdl:output>
                <soap:body use="literal" />
            </wsdl:output>
        </wsdl:operation>
        <wsdl:operation name="GetCitiesByCountry">
            <soap:operation soapAction="http://www.webserviceX.NET/GetCitiesByCountry" style="document" />
            <wsdl:input>
                <soap:body use="literal" />
            </wsdl:input>
            <wsdl:output>
                <soap:body use="literal" />
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
    <wsdl:binding name="GlobalWeatherSoap12" type="tns:GlobalWeatherSoap">
        <soap12:binding transport="http://schemas.xmlsoap.org/soap/http" />
        <wsdl:operation name="GetWeather">
            <soap12:operation soapAction="http://www.webserviceX.NET/GetWeather" style="document" />
            <wsdl:input>
                <soap12:body use="literal" />
            </wsdl:input>
            <wsdl:output>
                <soap12:body use="literal" />
            </wsdl:output>
        </wsdl:operation>
        <wsdl:operation name="GetCitiesByCountry">
            <soap12:operation soapAction="http://www.webserviceX.NET/GetCitiesByCountry" style="document" />
            <wsdl:input>
                <soap12:body use="literal" />
            </wsdl:input>
            <wsdl:output>
                <soap12:body use="literal" />
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
    <wsdl:binding name="GlobalWeatherHttpGet" type="tns:GlobalWeatherHttpGet">
        <http:binding verb="GET" />
        <wsdl:operation name="GetWeather">
            <http:operation location="/GetWeather" />
            <wsdl:input>
                <http:urlEncoded />
            </wsdl:input>
            <wsdl:output>
                <mime:mimeXml part="Body" />
            </wsdl:output>
        </wsdl:operation>
        <wsdl:operation name="GetCitiesByCountry">
            <http:operation location="/GetCitiesByCountry" />
            <wsdl:input>
                <http:urlEncoded />
            </wsdl:input>
            <wsdl:output>
                <mime:mimeXml part="Body" />
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
    <wsdl:binding name="GlobalWeatherHttpPost" type="tns:GlobalWeatherHttpPost">
        <http:binding verb="POST" />
        <wsdl:operation name="GetWeather">
            <http:operation location="/GetWeather" />
            <wsdl:input>
                <mime:content type="application/x-www-form-urlencoded" />
            </wsdl:input>
            <wsdl:output>
                <mime:mimeXml part="Body" />
            </wsdl:output>
        </wsdl:operation>
        <wsdl:operation name="GetCitiesByCountry">
            <http:operation location="/GetCitiesByCountry" />
            <wsdl:input>
                <mime:content type="application/x-www-form-urlencoded" />
            </wsdl:input>
            <wsdl:output>
                <mime:mimeXml part="Body" />
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
    <wsdl:service name="GlobalWeather">
        <wsdl:port name="GlobalWeatherSoap" binding="tns:GlobalWeatherSoap">
            <soap:address location="http://www.webservicex.net/globalweather.asmx" />
        </wsdl:port>
        <wsdl:port name="GlobalWeatherSoap12" binding="tns:GlobalWeatherSoap12">
            <soap12:address location="http://www.webservicex.net/globalweather.asmx" />
        </wsdl:port>
        <wsdl:port name="GlobalWeatherHttpGet" binding="tns:GlobalWeatherHttpGet">
            <http:address location="http://www.webservicex.net/globalweather.asmx" />
        </wsdl:port>
        <wsdl:port name="GlobalWeatherHttpPost" binding="tns:GlobalWeatherHttpPost">
            <http:address location="http://www.webservicex.net/globalweather.asmx" />
        </wsdl:port>
    </wsdl:service>
</wsdl:definitions>

另外github上還有一些Gradle的外掛來幫你實現xml和java物件的轉換,但是本質上其實還是使用了jaxb的xjc ant外掛實現的,只不過隱藏了實現細節,使用起來更加方便。感興趣的可以看https://github.com/jacobono/gradle-jaxb-plugin

相關文章