Springmvc RestTemplate 使用 && json xml rest 配置

以你之姓@ 2021-06-24 15:56 463阅读 0赞

## JSON：http://howtodoinjava.com/spring/spring-restful/spring-rest-hello-world-json-example/ ##

## XML：http://howtodoinjava.com/spring/spring-restful/spring-rest-hello-world-xml-example/ ##

## HTTP GET Method Example ##

1) Get XML representation of employees collection in String format

REST API Code

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>@RequestMapping</code> 
      <code>(value = </code> 
      <code>"/employees"</code> 
      <code>, produces = MediaType.APPLICATION_XML_VALUE, method = RequestMethod.GET)</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>public</code> 
      <code>String getAllEmployeesXML(Model model) </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>model.addAttribute(</code> 
      <code>"employees"</code> 
      <code>, getEmployeesCollection());</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return</code> 
      <code>"xmlTemplate"</code> 
      <code>;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

REST Client Code

2) Get JSON representation of employees collection in String format

REST API Code

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>@RequestMapping</code> 
      <code>(value = </code> 
      <code>"/employees"</code> 
      <code>, produces = MediaType.APPLICATION_JSON_VALUE,&nbsp; method = RequestMethod.GET)</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>public</code> 
      <code>String getAllEmployeesJSON(Model model) </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>model.addAttribute(</code> 
      <code>"employees"</code> 
      <code>, getEmployeesCollection());</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return</code> 
      <code>"jsonTemplate"</code> 
      <code>;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

REST Client Code

3) Using custom HTTP Headers with RestTemplate

REST API Code

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>@RequestMapping</code> 
      <code>(value = </code> 
      <code>"/employees"</code> 
      <code>, produces = MediaType.APPLICATION_JSON_VALUE,&nbsp; method = RequestMethod.GET)</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>public</code> 
      <code>String getAllEmployeesJSON(Model model) </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>model.addAttribute(</code> 
      <code>"employees"</code> 
      <code>, getEmployeesCollection());</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return</code> 
      <code>"jsonTemplate"</code> 
      <code>;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

REST Client Code

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>private</code> 
      <code>static</code> 
      <code>void</code> 
      <code>getEmployees()</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>final</code> 
      <code>String uri = </code> 
      <code>"<a href="http://localhost:8080/springrestexample/employees" rel="nofollow">http://localhost:8080/springrestexample/employees</a>"</code> 
      <code>;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>RestTemplate restTemplate = </code> 
      <code>new</code> 
      <code>RestTemplate();</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>HttpHeaders headers = </code> 
      <code>new</code> 
      <code>HttpHeaders();</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>HttpEntity&lt;String&gt; entity = </code> 
      <code>new</code> 
      <code>HttpEntity&lt;String&gt;(</code> 
      <code>"parameters"</code> 
      <code>, headers);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>ResponseEntity&lt;String&gt; result = restTemplate.exchange(uri, HttpMethod.GET, entity, String.</code> 
      <code>class</code> 
      <code>);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(result);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

4) Get data as mapped object

REST API Code

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>@RequestMapping</code> 
      <code>(value = </code> 
      <code>"/employees"</code> 
      <code>, produces = MediaType.APPLICATION_XML_VALUE, method = RequestMethod.GET)</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>public</code> 
      <code>String getAllEmployeesXML(Model model) </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>model.addAttribute(</code> 
      <code>"employees"</code> 
      <code>, getEmployeesCollection());</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return</code> 
      <code>"xmlTemplate"</code> 
      <code>;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

REST Client Code

5) Passing parameters in URL

REST API Code

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>@RequestMapping</code> 
      <code>(value = </code> 
      <code>"/employees/{id}"</code> 
      <code>)</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>public</code> 
      <code>ResponseEntity&lt;EmployeeVO&gt; getEmployeeById (</code> 
      <code>@PathVariable</code> 
      <code>(</code> 
      <code>"id"</code> 
      <code>)</code> 
      <code>int</code> 
      <code>id)</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>if</code> 
      <code>(id &lt;= </code> 
      <code>3</code> 
      <code>) { </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>EmployeeVO employee = </code> 
      <code>new</code> 
      <code>EmployeeVO(</code> 
      <code>1</code> 
      <code>,</code> 
      <code>"Lokesh"</code> 
      <code>,</code> 
      <code>"Gupta"</code> 
      <code>,</code> 
      <code>"howtodoinjava@gmail.com"</code> 
      <code>);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return</code> 
      <code>new</code> 
      <code>ResponseEntity&lt;EmployeeVO&gt;(employee, HttpStatus.OK);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return</code> 
      <code>new</code> 
      <code>ResponseEntity(HttpStatus.NOT_FOUND);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

REST Client Code

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>private</code> 
      <code>static</code> 
      <code>void</code> 
      <code>getEmployeeById()</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>final</code> 
      <code>String uri = </code> 
      <code>"<a href="http://localhost:8080/springrestexample/employees/" rel="nofollow">http://localhost:8080/springrestexample/employees/</a>{id}"</code> 
      <code>;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>Map&lt;String, String&gt; params = </code> 
      <code>new</code> 
      <code>HashMap&lt;String, String&gt;();</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>params.put(</code> 
      <code>"id"</code> 
      <code>,</code> 
      <code>"1"</code> 
      <code>);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>RestTemplate restTemplate = </code> 
      <code>new</code> 
      <code>RestTemplate();</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>EmployeeVO result = restTemplate.getForObject(uri, EmployeeVO.</code> 
      <code>class</code> 
      <code>, params);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(result);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

## HTTP POST Method Example ##

REST API Code

REST Client Code

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>private</code> 
      <code>static</code> 
      <code>void</code> 
      <code>createEmployee()</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>final</code> 
      <code>String uri = </code> 
      <code>"<a href="http://localhost:8080/springrestexample/employees" rel="nofollow">http://localhost:8080/springrestexample/employees</a>"</code> 
      <code>;</code> 
     </div> 
     <div style="margin-left:0px;">
       &nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>EmployeeVO newEmployee = </code> 
      <code>new</code> 
      <code>EmployeeVO(-</code> 
      <code>1</code> 
      <code>,</code> 
      <code>"Adam"</code> 
      <code>,</code> 
      <code>"Gilly"</code> 
      <code>,</code> 
      <code>"test@email.com"</code> 
      <code>);</code> 
     </div> 
     <div style="margin-left:0px;">
       &nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>RestTemplate restTemplate = </code> 
      <code>new</code> 
      <code>RestTemplate();</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>EmployeeVO result = restTemplate.postForObject( uri, newEmployee, EmployeeVO.</code> 
      <code>class</code> 
      <code>);</code> 
     </div> 
     <div style="margin-left:0px;">
       &nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(result);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

## HTTP PUT Method Example ##

REST API Code

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>@RequestMapping</code> 
      <code>(value = </code> 
      <code>"/employees/{id}"</code> 
      <code>, method = RequestMethod.PUT)</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>public</code> 
      <code>ResponseEntity&lt;EmployeeVO&gt; updateEmployee(</code> 
      <code>@PathVariable</code> 
      <code>(</code> 
      <code>"id"</code> 
      <code>)</code> 
      <code>int</code> 
      <code>id,</code> 
      <code>@RequestBody</code> 
      <code>EmployeeVO employee) </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(id);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(employee);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>return</code> 
      <code>new</code> 
      <code>ResponseEntity&lt;EmployeeVO&gt;(employee, HttpStatus.OK);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

REST Client Code

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>private</code> 
      <code>static</code> 
      <code>void</code> 
      <code>deleteEmployee()</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>final</code> 
      <code>String uri = </code> 
      <code>"<a href="http://localhost:8080/springrestexample/employees/" rel="nofollow">http://localhost:8080/springrestexample/employees/</a>{id}"</code> 
      <code>;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>Map&lt;String, String&gt; params = </code> 
      <code>new</code> 
      <code>HashMap&lt;String, String&gt;();</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>params.put(</code> 
      <code>"id"</code> 
      <code>,</code> 
      <code>"2"</code> 
      <code>);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>EmployeeVO updatedEmployee = </code> 
      <code>new</code> 
      <code>EmployeeVO(</code> 
      <code>2</code> 
      <code>,</code> 
      <code>"New Name"</code> 
      <code>,</code> 
      <code>"Gilly"</code> 
      <code>,</code> 
      <code>"test@email.com"</code> 
      <code>);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>RestTemplate restTemplate = </code> 
      <code>new</code> 
      <code>RestTemplate();</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>restTemplate.put ( uri, updatedEmployee, params);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

## HTTP DELETE Method Example ##

REST API Code

REST Client Code

<table> 
 <tbody> 
  <tr> 
   <td style="vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>private</code> 
      <code>static</code> 
      <code>void</code> 
      <code>deleteEmployee()</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>final</code> 
      <code>String uri = </code> 
      <code>"<a href="http://localhost:8080/springrestexample/employees/" rel="nofollow">http://localhost:8080/springrestexample/employees/</a>{id}"</code> 
      <code>;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>Map&lt;String, String&gt; params = </code> 
      <code>new</code> 
      <code>HashMap&lt;String, String&gt;();</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>params.put(</code> 
      <code>"id"</code> 
      <code>,</code> 
      <code>"2"</code> 
      <code>);</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>RestTemplate restTemplate = </code> 
      <code>new</code> 
      <code>RestTemplate();</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>restTemplate.delete ( uri,&nbsp; params );</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

Let me know if something needs more explanation.