基於restful風格的maven項目實踐（融合spring）

我們我們經常在老式的項目開發過程中，遇到找java包的問題；甚至有時候一找一天就過去了。maven 是我們開發工程師的福音，它可以根據我們的配置自動的下載並加裝到我們的工程中，並在發佈的時候同時發佈對應的Java包。這樣大大提高了我們的工作效率，更有時間學習前沿的技術。

什麼是maven？

maven是專用於進行項目的配置管理工作；用maven創建的項目中必須包括一個pom.xml文件，用於設置依賴關係、項目的基本配置（grouId，artifactId，version等），編譯項目時用插件、環境配置、發佈管理、私服庫配置等。這樣我們不用太多關心項目的配置方面的問題，而是更專注於具體業務環境的開發。我們可以快速搭建起開發框架，通過maven來管理項目配置。

什麼是restful？

一種軟件架構風格，設計風格而不是標準，只是提供了一組設計原則和約束條件。它主要用於客戶端和服務器交互類的軟件。基於這個風格設計的軟件可以更簡潔，更有層次，更易於實現緩存等機制。其實說白了就是讓我們開發的代碼更少，通過很少代碼實現複雜的功能。

在maven項目中，我們需要有一個pom.xml文件；我們一實際舉個例子，先講一下項目背景：此項目主要是實現restful風格的接口項目，用於其他模塊調用使用。開發的思路：先配置一個pom.xml文件然後在webapp/WEB-INFO目錄下創建web.xml文件用spring這個框架模擬get、form提交的post方式來進行數據的交互。大家可以按照自己實際的要求刪減配置。

pom.xml 文件如下

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.seven.spring</groupId>
	<artifactId>springtest</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>war</packaging>
	<!-- 定義一些屬於變量，用於配置中使用，方面版本升級 -->
	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<contextpath>easydoctor</contextpath>
		<java.version>1.8</java.version>
		<json-path-assert.version>2.0.0</json-path-assert.version>
		<h2.version>1.4.184</h2.version>

		<maven-compiler-plugin.version>3.1</maven-compiler-plugin.version>
		<tomcat7-maven-plugin.version>2.0-beta-1</tomcat7-maven-plugin.version>
		<maven-project-info-reports-plugin.version>2.7</maven-project-info-reports-plugin.version>
		<maven-javadoc-plugin.version>2.9.1</maven-javadoc-plugin.version>
		<maven-jxr-plugin.version>2.3</maven-jxr-plugin.version>
	</properties>

	<build>
		<finalName>springtest</finalName>
		<resources>
			<resource>
				<directory>src/main/resources/</directory>
				<filtering>true</filtering>
			</resource>
		</resources>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>${maven-compiler-plugin.version}</version>
				<configuration>
					<source>${java.version}</source>
					<target>${java.version}</target>
					<encoding>utf-8</encoding>
				</configuration>
			</plugin>

		</plugins>
	</build>

	<dependencies>
	    <!-- 用於spring mvc 項目開發需要 -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-webmvc</artifactId>
			<version>4.1.7.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>commons-io</groupId>
			<artifactId>commons-io</artifactId>
			<version>2.4</version>
		</dependency>
		<dependency>
			<groupId>commons-fileupload</groupId>
			<artifactId>commons-fileupload</artifactId>
			<version>1.3.1</version>
		</dependency>

		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-tx</artifactId>
			<version>4.1.7.RELEASE</version>
		</dependency>

		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context-support</artifactId>
			<version>4.1.7.RELEASE</version>
		</dependency>

		<dependency>
			<groupId>org.freemarker</groupId>
			<artifactId>freemarker</artifactId>
			<version>2.3.23</version>
		</dependency>
		<!-- 用於json 序列化 和反序列話 -->
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-core</artifactId>
			<version>2.5.4</version>
		</dependency>
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-annotations</artifactId>
			<version>2.5.4</version>
		</dependency>
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-databind</artifactId>
			<version>2.5.4</version>
		</dependency>
		<!-- servlet採用常見的接受請求和生成響應的編程模型 ,由sun公司開發的 -->
		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>javax.servlet-api</artifactId>
			<version>3.1.0</version>
			<scope>provided</scope>
			<!-- provided 隻影響在編譯 測試階段使用，不會在發佈、打包等階段將包放入lib目錄下，常用於我們發佈的目標容器中已經存在包 -->
		</dependency>
		
		<!-- 用於在代碼中自動生成set/get -->
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.16.4</version>
		</dependency>
		
		<!-- 用於處理json對象需要的包 -->
		<dependency>  
		    <groupId>org.codehaus.jackson</groupId>  
		    <artifactId>jackson-core-asl</artifactId>  
		    <version>1.8.4</version>  
		</dependency>  
		<dependency>  
		    <groupId>org.codehaus.jackson</groupId>  
		    <artifactId>jackson-mapper-asl</artifactId>  
		    <version>1.8.4</version>  
		</dependency>  
		
		<dependency> 
			<groupId>org.codehaus.jackson</groupId> 
			<artifactId>jackson-core-asl</artifactId> 
			<version>1.8.4</version> 
		</dependency> 
		<dependency> 
			<groupId>org.codehaus.jackson</groupId> 
			<artifactId>jackson-mapper-asl</artifactId> 
			<version>1.8.4</version>
		</dependency>  
		
	</dependencies>


</project>

我們知道spring 的web項目是需要在webapp/WEB-INFO 目錄下創建一個web.xml文檔用戶進行相關web運行的設定（類過濾器，事務、dispatchseverlet 配置等）

web.xml文檔如下

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
    version="3.0">
 <!--  <listener>
    <listener-class>com.seven.PreContextLoaderListener</listener-class>
  </listener> 
  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath*:META-INF/spring/root/*.xml</param-value>
  </context-param>-->
  <servlet>
    <servlet-name>rest</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath*:rest-context.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>rest</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>
  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.htm</welcome-file>
    <welcome-file>default.jsp</welcome-file>
  </welcome-file-list>
  <!--
  <filter>
    <display-name>SignerFilter</display-name>
    <filter-name>SignerFilter</filter-name>
    <filter-class>com.seven.SignerFilter</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>SignerFilter</filter-name>
    <url-pattern>/apiController</url-pattern>
    <dispatcher>REQUEST</dispatcher>
  </filter-mapping>
  <filter>
    <display-name>ApiConvertFilter</display-name>
    <filter-name>ApiConvertFilter</filter-name>
    <filter-class>com.seven.api</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>ApiConvertFilter</filter-name>
    <url-pattern>/apiController</url-pattern>
  </filter-mapping>-->
  
  
</web-app>

在web.xml的配置文件中，classpath*:rest-context.xml 作用是會加載這個配置運行，常在此配置中配置一些Bean，用於容器加載的時候自動創建對應的類對象（一般創建的對象都是singleton模式）；

rest-context.xml 文件如下：

<?xml version="1.0" encoding="UTF-8"?>  
<beans xmlns="http://www.springframework.org/schema/beans"  
    xmlns:mvc="http://www.springframework.org/schema/mvc"  
    xmlns:context="http://www.springframework.org/schema/context"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xsi:schemaLocation="http://www.springframework.org/schema/beans   
  
http://www.springframework.org/schema/beans/spring-beans-4.1.xsd   
  
  
http://www.springframework.org/schema/mvc   
  
  
http://www.springframework.org/schema/mvc/spring-mvc.xsd   
  
  
http://www.springframework.org/schema/context   
  
  
http://www.springframework.org/schema/context/spring-context-4.1.xsd">  

    <!-- 掃描包下的annotation標記  Controller Service  restController等 -->
    <context:component-scan base-package="com.seven.spring" />
    <!-- 定義一個bean對象 -->
    <bean id="userDetails" class="com.seven.spring.UserDetails"/>  
    <!-- 自動配置項 -->
    <mvc:annotation-driven />  
    <context:annotation-config/>  
    <!-- 內容管理器配置  -->
    <bean id="contentManager"  
                class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">  
                <property name="favorPathExtension" value="true"/>  
                <property name="ignoreAcceptHeader" value="true" />  
                <property name="defaultContentType" value="text/html" />  
                <property name="useJaf" value="false"/>  
                <property name="mediaTypes">  
                    <map>  
                        <entry key="json" value="application/json" />  
                        <entry key="html" value="text/html" />  
                        <entry key="xml" value="application/xml" />  
                    </map>  
                </property>  
        </bean> 
     <!-- jsp視圖解析器配置  主要設定ModelAndView 的前綴、後綴 --> 
    <bean id="jspViewResolver"  
        class="org.springframework.web.servlet.view.InternalResourceViewResolver">  
        <property name="prefix" value="/WEB-INF/jsp/" />  
        <property name="suffix" value=".jsp" />  
    </bean>    
</beans>

基本配置完成後就是寫代碼了，我這邊主要做一些簡單的接口測試；相關代碼如下

package com.seven.spring;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;   
  
@RestController  
public class SpringRestControllerDemo {   
    @Autowired UserDetails userDetails;  
   /*  @RequestMapping(value="/springcontent",   
    method=RequestMethod.GET,produces={"application/xml", "application/json"}) 
    @RequestMapping(value="/springcontent.json",   
            method=RequestMethod.GET) */  
    @RequestMapping(value="/springcontent",method=RequestMethod.POST) 
    @ResponseStatus(HttpStatus.OK)   
    public UserDetails getUser() {   
        UserDetails userDetails = new UserDetails();   
        userDetails.setUserName("seven");   
        userDetails.setEmailId("[email protected]");   
        return userDetails;   
    }   
    
    @RequestMapping(value = "springcontentadd", method = RequestMethod.POST)
    public UserDetails addUser(@RequestBody  UserDetails userDetails) {
    	System.out.println("userdetail="+userDetails);
        return userDetails;
    }
    
    @RequestMapping(value = "springcontentpar", method = RequestMethod.POST)
    public String getRquerypar(@RequestParam("name")  String userDetails) {
    	System.out.println("userdetail="+userDetails);
        return userDetails;
    }
  
    @RequestMapping(value="/springcontent.htm", method=RequestMethod.GET)   
    @ResponseStatus(HttpStatus.OK)   
    public String getUserHtml() {   
        //Test HTML view   
        return "example";   
    }   
}

大家在自己的本機創建試試。

基於restful風格的maven項目實踐（融合spring）

設計模式大總結

命令模式的應用

Maven 項目在集成Eclipse環境報錯

由正則表達式引申到解釋器模式

Form界面的各組件的工作原理---中介者模式

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結