{"id":5008,"date":"2017-05-29T18:43:49","date_gmt":"2017-05-29T18:43:49","guid":{"rendered":"http:\/\/putridparrot.com\/blog\/?p=5008"},"modified":"2020-11-11T18:57:03","modified_gmt":"2020-11-11T18:57:03","slug":"building-a-rest-service-with-spring","status":"publish","type":"post","link":"https:\/\/putridparrot.com\/blog\/building-a-rest-service-with-spring\/","title":{"rendered":"Building a REST service with Spring"},"content":{"rendered":"

I’ve been doing a fair bit with SOAP, REST and Java recently using CXF. A previous post demonstrated using CXF\/JAXB to create a REST style service that returned either JSON or XML, let’s look at using Spring REST services<\/a> to implement the same functionality.<\/p>\n

Let’s start (as usual) with our pom.xml<\/p>\n

\r\n<?xml version="1.0" encoding="UTF-8"?>\r\n<project xmlns="http:\/\/maven.apache.org\/POM\/4.0.0" xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance"\r\n    xsi:schemaLocation="http:\/\/maven.apache.org\/POM\/4.0.0 http:\/\/maven.apache.org\/xsd\/maven-4.0.0.xsd">\r\n    <modelVersion>4.0.0<\/modelVersion>\r\n\r\n    <groupId>org.springframework<\/groupId>\r\n    <artifactId>sample-rest-service<\/artifactId>\r\n    <version>0.1.0<\/version>\r\n\r\n    <parent>\r\n        <groupId>org.springframework.boot<\/groupId>\r\n        <artifactId>spring-boot-starter-parent<\/artifactId>\r\n        <version>1.5.2.RELEASE<\/version>\r\n    <\/parent>\r\n\r\n    <dependencies>\r\n        <dependency>\r\n            <groupId>org.springframework.boot<\/groupId>\r\n            <artifactId>spring-boot-starter-web<\/artifactId>\r\n        <\/dependency>\r\n        <dependency>\r\n            <groupId>org.springframework.boot<\/groupId>\r\n            <artifactId>spring-boot-starter-test<\/artifactId>\r\n            <scope>test<\/scope>\r\n        <\/dependency>\r\n        <dependency>\r\n            <groupId>com.jayway.jsonpath<\/groupId>\r\n            <artifactId>json-path<\/artifactId>\r\n            <scope>test<\/scope>\r\n        <\/dependency>\r\n    <\/dependencies>\r\n\r\n    <properties>\r\n        <java.version>1.8<\/java.version>\r\n    <\/properties>\r\n\r\n\r\n    <build>\r\n        <plugins>\r\n            <plugin>\r\n                <groupId>org.springframework.boot<\/groupId>\r\n                <artifactId>spring-boot-maven-plugin<\/artifactId>\r\n            <\/plugin>\r\n        <\/plugins>\r\n    <\/build>\r\n\r\n    <repositories>\r\n        <repository>\r\n            <id>spring-releases<\/id>\r\n            <url>https:\/\/repo.spring.io\/libs-release<\/url>\r\n        <\/repository>\r\n    <\/repositories>\r\n    <pluginRepositories>\r\n        <pluginRepository>\r\n            <id>spring-releases<\/id>\r\n            <url>https:\/\/repo.spring.io\/libs-release<\/url>\r\n        <\/pluginRepository>\r\n    <\/pluginRepositories>\r\n<\/project>\r\n<\/pre>\n
Now we create our folder structure, so create the following from the root folder<\/p>\n
\r\nsrc\/main\/java\/demo\r\n<\/pre>\n
We’re going to need to code within the demo<\/em> package.<\/p>\n
Without the package you might see a warning “Your ApplicationContext is unlikely to start due to a @ComponentScan of the default package.”<\/em><\/p>\n
Next up, we’ll create a service, or in Spring parlance, the controller<\/p>\n
\r\npackage demo;\r\n\r\nimport org.springframework.web.bind.annotation.RequestMapping;\r\nimport org.springframework.web.bind.annotation.RestController;\r\n\r\n@RestController\r\npublic class SampleController {\r\n\r\n    @RequestMapping("\/purchaseOrder")\r\n    public PurchaseOrderType getPurchaseOrder() {\r\n        return new PurchaseOrderType(1234);\r\n    }\r\n}\r\n<\/pre>\n
The PurchaseOrderType is simply the following<\/p>\n
\r\npackage demo;\r\n\r\npublic class PurchaseOrderType {\r\n\r\n    private long _id;\r\n\r\n    public PurchaseOrderType(long id) {\r\n        _id = id;\r\n    }\r\n\r\n    public long getId() {\r\n        return _id;\r\n    }\r\n}\r\n<\/pre>\n
Now we need the application to start the service<\/p>\n
\r\npackage demo;\r\n\r\nimport org.springframework.boot.SpringApplication;\r\nimport org.springframework.boot.autoconfigure.SpringBootApplication;\r\n\r\n@SpringBootApplication\r\npublic class Application {\r\n\r\n    public static void main(String[] args) {\r\n        SpringApplication.run(Application.class, args);\r\n    }\r\n}\r\n<\/pre>\n
To run this we can, ofcourse, set up a configuration or from the Terminal window run<\/p>\n
\r\nmvn spring-boot:run\r\n<\/pre>\n
Now, if we navigate to http:\/\/localhost:8080\/purchaseOrder\/<\/em> we should see<\/p>\n
{"id":1234}<\/p>\n
Now, let’s extend this to allow us to return XML. We’ll need to annotate PurchaseOrderType with the @XmlRootElement, we’ll also need a default constructor and a setter for our Id property<\/p>\n
\r\npackage demo;\r\n\r\nimport javax.xml.bind.annotation.XmlRootElement;\r\n\r\n@XmlRootElement\r\npublic class PurchaseOrderType {\r\n\r\n    private long _id;\r\n\r\n    public PurchaseOrderType() {\r\n    }\r\n\r\n    public PurchaseOrderType(long id) {\r\n        _id = id;\r\n    }\r\n\r\n    public long getId() {\r\n        return _id;\r\n    }\r\n\r\n    public void setId(long id) {\r\n        _id = id;\r\n    }\r\n}\r\n<\/pre>\n
Changing the port of the Tomcat server<\/strong><\/p>\n
You may have noticed that when running this application we get an instance of a Tomcat server running, by default it uses port 8080, but what about if we need\/want to change this. We can create an EmbeddedServletContainerCustomizer, as below.<\/p>\n
\r\npackage demo;\r\n\r\nimport org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer;\r\nimport org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;\r\nimport org.springframework.stereotype.Component;\r\n\r\n@Component\r\npublic class ApplicationContainer implements EmbeddedServletContainerCustomizer {\r\n\r\n    @Override\r\n    public void customize(ConfigurableEmbeddedServletContainer configurableEmbeddedServletContainer) {\r\n        configurableEmbeddedServletContainer.setPort(8888);\r\n    }\r\n}\r\n<\/pre>\n
Code is available here https:\/\/github.com\/putridparrot\/blog-projects\/tree\/master\/spring-rest<\/p>\n","protected":false},"excerpt":{"rendered":"
I’ve been doing a fair bit with SOAP, REST and Java recently using CXF. A previous post demonstrated using CXF\/JAXB to create a REST style service that returned either JSON or XML, let’s look at using Spring REST services to implement the same functionality. Let’s start (as usual) with our pom.xml <?xml version="1.0" encoding="UTF-8"?> <project […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[161,164],"tags":[],"class_list":["post-5008","post","type-post","status-publish","format-standard","hentry","category-java","category-rest"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/5008","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/comments?post=5008"}],"version-history":[{"count":5,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/5008\/revisions"}],"predecessor-version":[{"id":8616,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/5008\/revisions\/8616"}],"wp:attachment":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/media?parent=5008"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/categories?post=5008"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/tags?post=5008"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}