2. 程式人生 > >SpringBoot+rest接口+swagger2生成API文檔+validator+mybatis+aop+國際化

SpringBoot+rest接口+swagger2生成API文檔+validator+mybatis+aop+國際化

阿新 • • 發佈：2017-08-16
create dea ppi pro time success 類定義 -- sse

代碼地址：JillWen_SpringBootDemo

mybatis

1. 添加依賴：

<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
            <version>${mybatis.version}</version>
		</dependency>

		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<!--這裏如果不寫版本會自動繼承spring-boot-starter-parent裏的版本號-->
			<version>${mysql.version}</version>
</dependency>

2. dao層定義UserMapper.xml文件和UserMapper類

3. 使用註意：

  1. 使用mybatisGenerator插件（idea裏直接裝需要收費，參考：http://blog.csdn.net/luanlouis/article/details/43192131）
  2. 添加依賴
<plugin>
               <groupId>org.mybatis.generator</groupId>
               <artifactId>mybatis-generator-maven-plugin</artifactId>
               <version>${mybatis-generator.version}</version>
               <configuration>
                   <verbose>true</verbose>
                   <overwrite>true</overwrite>
               </configuration>
</plugin>

添加一個“Run運行”選項，使用maven運行mybatis-generator-maven-plugin插件， 在 “Command line” 選項中輸入“mybatis-generator:generate -e”

  1. 當mapper.xml文件不是放在resource文件下時，需要加插件將其生成到target裏。 每次修改後需要install。
<plugin>
				<artifactId>maven-resources-plugin</artifactId>
				<version>2.5</version>
				<executions>
					<execution>
						<id>copy-xmls</id>
						<phase>process-sources</phase>
						<goals>
							<goal>copy-resources</goal>
						</goals>
						<configuration>
							<outputDirectory>${basedir}/target/classes</outputDirectory>
							<resources>
								<resource>
									<directory>${basedir}/src/main/java</directory>
									<includes>
										<include>**/*.xml</include>
									</includes>
								</resource>
							</resources>
						</configuration>
					</execution>
				</executions>
</plugin>
  1. [email protected]（@MapperScan("com.example.demo.server.dao")） 時idea會報錯，但是可以運行，[email protected]

restful接口

1. restful接口定義

（參考：http://websystique.com/spring-boot/spring-boot-rest-api-example/）：

  • GET request to /users/ returns a list of users
  • GET request to /users/1 returns the user with ID 1
  • POST request to /users/ with a user object as JSON creates a new user
  • PUT request to /users/1 with a user object as JSON updates the user with ID 1
  • DELETE request to /users/1 deletes the user with ID 1
  • DELETE request to /users/ deletes all the users

2. controller裏主要代碼

@Autowired
   IUserService userService;

   /**
    * 查詢所有用戶
    * @return
    */
   @RequestMapping(value = "/", method = RequestMethod.GET)
   public List<User> listAllUsers() {
       List<User> users = userService.findAllUsers();
       return users;
   }

   /**
    * 根據id查詢用戶
    * @param id
    * @return
    */
   @RequestMapping(value = "/{id}", method = RequestMethod.GET)
   public User getUser(@PathVariable("id") int id) {
       logger.info("Fetching User with id {}", id);
       User user = userService.findById(id);
       if (user == null) {
           logger.error("User with id {} not found.", id);
       }
       return user;
   }

   /**
    * 新建一個用戶
    * @param user
    * @return
    */
   @RequestMapping(value = "/", method = RequestMethod.POST)
   public String createUser(@ModelAttribute  User user) {
       [email protected]，[email protected]/RequestBody ?
       logger.info("Creating User : {}", user);
       User exitUser = new User();
       exitUser.setId(user.getId());
       if (userService.isUserExist(exitUser)) {
           logger.error("Unable to create. A User with id {} already exist", exitUser.getId());
       }
       userService.saveUser(user);
       return "success";
   }

   /**
    * 根據id更新用戶信息
    * @param id
    * @param user
    * @return
    */
   @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
   public String updateUser(@PathVariable("id") int id, @ModelAttribute User user) {
       //RequestBody
       logger.info("Updating User with id {}", id);

       User currentUser = userService.findById(id);

       if (currentUser == null) {
           logger.error("Unable to update. User with id {} not found.", id);
           return "fail";
       }
       currentUser.setName(user.getName());
       currentUser.setAge(user.getAge());
       userService.updateUser(currentUser);
       return "success";
   }

   /**
    * 根據id刪除用戶
    * @param id
    * @return
    */
   @RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
   public String deleteUser(@PathVariable("id") int id) {
       logger.info("Fetching & Deleting User with id {}", id);

       User user = userService.findById(id);
       if (user == null) {
           logger.error("Unable to delete. User with id {} not found.", id);
           return "fail";
       }
       userService.deleteUserById(id);
       return "success";
   }


   /**
    * 刪除所有用戶
    * @return
    */
   @RequestMapping(value = "/", method = RequestMethod.DELETE)
   public String deleteAllUsers() {
       logger.info("Deleting All Users");

       userService.deleteAllUsers();
       return "success";
   }

測試（使用postman）：

查詢所有用戶

技術分享

查詢id為1的用戶

技術分享

創建一個用戶

技術分享

更新id為1的用戶

技術分享

技術分享

3.使用swagger2生成api文檔

（參考http://blog.didispace.com/springbootswagger2/）

  1. 引入依賴
<dependency>
           <groupId>io.springfox</groupId>
           <artifactId>springfox-swagger2</artifactId>
           <version>2.2.2</version>
       </dependency>
       <dependency>
           <groupId>io.springfox</groupId>
           <artifactId>springfox-swagger-ui</artifactId>
           <version>2.2.2</version>
</dependency>
  1. 創建Swagger2配置類
@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.server.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2構建RESTful APIs")
                .description("使用Swagger2構建RESTful APIs")
                .termsOfServiceUrl("http://www.wjcoding.cn/")
                .contact("Jill")
                .version("1.0")
                .build();
    }
}
  1. controller裏使用：
@ApiOperation(value="創建用戶", notes="根據User對象創建用戶")
    @ApiImplicitParam(name = "user", value = "用戶詳細實體user", required = true, dataType = "User")
    @RequestMapping(value = "/", method = RequestMethod.POST)
    public String createUser(@ModelAttribute  User user) {
    //代碼略
    }
  1. 查看api文檔: 啟動Spring Boot程序，訪問：http://localhost:8080/swagger-ui.html

技術分享

國際化

(參考博客：http://412887952-qq-com.iteye.com/blog/2312274)

1. 頁面中使用國際化

創建messages.properties（messages_zh_CN.properties，messages_en_US.properties）文件 thymeleaf裏使用#{key}顯示，例如：<p th:text="#{welcome}"></p>

2. 國際化文件相關配置

#指定message的basename，多個以逗號分隔，如果不加包名的話，默認從classpath路徑開始，默認: messages spring.messages.basename=i18n/messages #設定加載的資源文件緩存失效時間，-1的話為永不過期，默認為-1 spring.messages.cache-seconds=3600 #設定Message bundles的編碼，默認: UTF-8 #spring.messages.encoding=UTF-8

驗證：火狐地址欄裏輸入about:config回車，搜索accept_languages,改成en_US,en

技術分享

技術分享

3. 代碼中使用國際化

  1. 創建messages.properties（messages_zh_CN.properties，messages_en_US.properties）文件
  2. 代碼裏先獲取區域，再國際化信息:
Locale locale = LocaleContextHolder.getLocale();
（或者Locale locale = RequestContextUtils.getLocale(request);）
String msg = messageSource.getMessage("welcome", null,locale);

  • 區域解析器 默認：AcceptHeaderLocaleResolver 根據HTTP請求的頭部信息accept-language來解析區域

  • 會話區域解析器：SessionLocaleResolver

@Bean
  public LocaleResolver localeResolver() {
      SessionLocaleResolver slr = new SessionLocaleResolver();
      //設置默認區域
      slr.setDefaultLocale(Locale.CHINA);
      return slr;
  }
request.getSession().setAttribute(SessionLocaleResolver.LOCALE_SESSION_ATTRIBUTE_NAME, new Locale("en", "US"))
  • Cookie區域解析器：CookieLocaleResolver
@Bean
    public LocaleResolver localeResolver() {
       CookieLocaleResolver slr = new CookieLocaleResolver();
        //設置默認區域
        slr.setDefaultLocale(Locale.CHINA);
        slr.setCookieMaxAge(3600);//設置cookie有效期.
        returnslr;
    }
  • 固定的區域解析器:FixedLocaleResolver
@Bean
    public LocaleResolver localeResolver() {
       FixedLocaleResolver slr = new FixedLocaleResolver ();
        //設置默認區域
        slr.setDefaultLocale(Locale.US);
        returnslr;
    }
  • 使用參數修改用戶的區域 將LocaleChangeInterceptor攔截器應用到處理程序映射中，它會發現當前HTTP請求中出現的特殊參數。 其中的參數名稱可以通過攔截器的paramName屬性進行自定義。 如果這種參數出現在當前請求中，攔截器就會根據參數值來改變用戶的區域。
@Bean
 public LocaleChangeInterceptor localeChangeInterceptor() {
        LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
        // 設置請求地址的參數,默認為：locale
        // lci.setParamName(LocaleChangeInterceptor.DEFAULT_PARAM_NAME);
        return lci;
}

@Override
public void addInterceptors(InterceptorRegistry registry) {
   registry.addInterceptor(localeChangeInterceptor());
}

註意這個是可以和會話區域解析器以及Cookie區域解析器一起使用的， 但是不能和FixedLocaleResolver一起使用，否則會拋出異常信息。

驗證：

技術分享

技術分享

技術分享

aop

(參考：http://blog.didispace.com/springbootaoplog/)

1. 添加依賴

<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2. 使用：

實現AOP的切面主要有以下幾個要素：

  • [email protected]
  • @Order(i)註解來標識切面的優先級。i的值越小，優先級越高。
    1. 在切入點前的操作，按order的值由小到大執行
    1. 在切入點後的操作，按order的值由大到小執行
  • [email protected]，可以是一個規則表達式，比如下例中某個package下的所有函數，也可以是一個註解等。 根據需要在切入點不同位置的切入內容
  • [email protected]
  • [email protected]
  • [email protected]（可以用來對處理返回值做一些加工處理）
  • [email protected]，並自己控制何時執行切入點自身的內容
  • [email protected]之後的處理邏輯
@Aspect
@Component
@Order(1)
public class WebLogAspect {
    private Logger logger = Logger.getLogger(WebLogAspect.class);
    ThreadLocal<Long> startTime = new ThreadLocal<>();

    @Pointcut("execution(public * com.example.demo.server.controller..*.*(..))")
    public void webLog(){}

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        startTime.set(System.currentTimeMillis());
        // 接收到請求，記錄請求內容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 記錄下請求內容
        logger.info("URL : " + request.getRequestURL().toString());
        logger.info("HTTP_METHOD : " + request.getMethod());
        logger.info("IP : " + request.getRemoteAddr());
        logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));
    }

    @AfterReturning(returning = "ret",pointcut = "webLog()")
    public void doAfterReturning(Object ret) throws Throwable {
        // 處理完請求，返回內容
        logger.info("RESPONSE : " + ret);
        logger.info("RESPONSE : " + ret);
        logger.info("SPEND TIME : " + (System.currentTimeMillis() - startTime.get()));
    }
}


validator

（參考http://www.jianshu.com/p/a9b1e2f7a749）

1. 添加限制

[email protected]，因為id類型為int
  private int id;

  //使用groups屬性來給分組命名，然後在需要的地方指定命令即可
  @NotBlank(groups=NAME.class)
  private String name;

  @Min(1)
  private Integer age;

2. 使用驗證

@RestController
public class ValidateController {
    @RequestMapping(value="testUser")
    public void testStudent(@Validated User user) {
    }

    @RequestMapping(value="testUser1")
    public void testStudent1(@Validated(User.NAME.class) User user) {
    }
}

使用 @ScriptAssert 註解校驗復雜的業務邏輯: 如果需要校驗的業務邏輯比較復雜,[email protected]， 通過方法來進行復雜業務邏輯的校驗，然後返回 true或false來表明是否校驗成功。

@ScriptAssert(lang="javascript",script="com.learn.validate.domain
.Student.checkParams(_this.name,_this.age,_this.classes)",
groups=CHECK.class)
public class Student {
//其他代碼
/註意進行校驗的方法要寫成靜態方法，否則會出現
 //TypeError: xxx is not a function 的錯誤
 public static boolean checkParams(String name,int age,String classes) {
  if(name!=null&&age>8&classes!=null)
  {
   return true;
  }
  else
  {
   return false;
  }
 }
}

3. 註意：

在Hibernate Validator（org.hibernate.validator.constraints）中：

@NotEmpty://CharSequence, Collection, Map 和 Array 對象不能是 null 並且相關對象的 size 大於 0。 @NotBlank://String 不是 null 且去除兩端空白字符後的長度（trimmed length）大於 0。

驗證：

技術分享

SpringBoot+rest接口+swagger2生成API文檔+validator+mybatis+aop+國際化

相關推薦

SpringBoot+rest接口+swagger2生成API文檔+validator+mybatis+aop+國際化

create dea ppi pro time success 類定義 -- sse 代碼地址：JillWen_SpringBootDemo mybatis 1. 添加依賴： <dependency> <groupId>org.m

SpringBoot整合Swagger2生成Api文件

SpringBoot整合Swagger2一、新增Swagger2 pom依賴檔案1、此處為根目錄下pom依賴<properties>    <swagger.version>2.4.0</swagger.version>  </pro

WisdomTool REST Client支持自動化測試並可以生成API文檔

log get bsp src net 美的 south ref 地址 WisdomTool REST Client V1.1 支持自動化測試RESTful API並生成精美的測試報告，同時基於歷史數據自動生成精美的RESTful API文檔。 工具地址：https://g

Django Rest Swagger生成api文檔

bject ews 實現 ngs 原因 perl ida ram sage 關於swagger Swagger能成為最受歡迎的REST APIs文檔生成工具之一，有以下幾個原因： Swagger 可以生成一個具有互動性的API控制臺，開發者可以用來快速學習和嘗試API。

使用Xcode生成API文檔---01簡介

沒有 code doxygen ont gpo docs font 界面 優點 生成技術文檔主要有三個工具: 1.headerdoc, 優點：xcode 自帶的文檔生成工具、基於命令行的操作、使用方便。 缺點：但是只能生成以 /*! */ 的格式的註釋。還有一

使用Xcode生成API文檔---02HeaderDoc

scale clas pts help 圖片 db4 所有 模式 手寫 如何使用Xcode生成你的技術文檔. 生成技術文檔主要有三個工具: headerdoc, doxygen 和 appledoc.其中headerdoc是蘋果官方的生成工具,後兩個是第三方工具.如果Xco

使用springfox+swagger2書寫API文檔（十八）

添加 沒有 mit core 註意 集合 ota ignore sta 使用springfox+swagger2書寫API文檔 springfox是通過註解的形式自動生成API文檔，利用它，可以很方便的書寫restful API，swagger主要用於展示springfox

Spring集成Swagger，Java自動生成Api文檔

jar包 depend pan restful can nic -a src 構建 博主很懶... Swagger官網：http://swagger.io GitHub地址：https://github.com/swagger-api 官方註解文檔：http://docs.

淺析如何在Nancy中生成API文檔

2.x span build inter 修改 ace 目前 前端開發 strac 原文:淺析如何在Nancy中生成API文檔前言 前後端分離，或許是現如今最為流行開發方式，包括UWP、Android和IOS這樣的手機客戶端都是需要調用後臺的API來進行數據的交互。 但

showdoc使用筆記（自動生成api文檔和數據庫字典）

都是 開發 mdt str cron 範圍 root .cn 開放api showdoc使用筆記（自動生成api文檔和數據庫字典） 以後終於不用開發前寫繁瑣的 api文檔和數據庫表字典了！！！！ showdoc開源系統下載地址：https://github.com/st

Laravel（PHP）使用Swagger生成API文檔不完全指南 - 基本概念和環境搭建 - 簡書

function 閱讀 編程語言 文字 formdata 自動 tom dev 開始 在PHPer中，很多人聽說過Swagger，部分人知道Swagger是用來做API文檔的，然而只有少數人真正知道怎麽正確使用Swagger，因為PHP界和Swagger相關的資料實在是太少

.net core WebApi 使用Swagger生成API文檔

啟用 ext 結點 program all ide tty 生成 sts 關於 Swagger Swagger能成為最受歡迎的REST APIs文檔生成工具之一，有以下幾個原因： Swagger 可以生成一個具有互動性的API控制臺，開發者可以用來快速學習和嘗試AP

使用swagger實現在線api文檔自動生成 在線測試api接口

在線測試 api接口 XML 工具 swagger 文檔自動生成 was 包管理工具 log 使用vs nuget包管理工具搜索Swashbuckle 然後安裝便可 註釋依賴於vs生成的xml註釋文件 使用swagger實現在線api文檔自動生成 在線測試api接口

SpringBoot整合swagger2，生成API文件

1、新增依賴 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency>

Springboot 框架實現rest接口風格

書寫規則 www ref href ring chang 規則 接口 註解 在springboot中的一些註解解釋： http://blog.csdn.net/u010399316/article/details/52913299 書寫規則可參照這個： http

使用generatorConfig工具自動生成mybatis的實體類以及dao接口和映射文件

color 大寫 nod com auto 主鍵 imm target ont 1：數據準備 創建一個數據庫表 1 CREATE TABLE `logininfo` ( 2 `id` BIGINT(20) NOT NULL AUTO_INCREMENT, 3 `u

Spring Boot 整合 swagger2 自動生成 RESTFul API 文檔

pat turn ket config 文件 pen 用戶 配置文件 方式 1）首先編輯pom.xml添加依賴 <dependency> 　　<groupId>io.springfox</groupId> 　　<artifactI

swagger2 離線文件 文件中心搭建 json swagger 自動生成api文件

最近找了一個自動生成api文件的工具swagger，相對swaggerEdit就不說了。個人比較懶，還是自動生成來的便捷，尤其是老專案，新專案在初期可能會維護，但是到了後期就很難保證了。所以，那些需要一些特殊配置說明的文件工具就不提了。 這篇文章主要是在swagger2 swagger UI的基

springboot+Swagger2生成API

配置pom.xml <!-- swagger生成介面API --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfo

SpringBoot結合swagger自動生成API文件

        Web開發常採用前後端分離的方式。前後端通過API進行互動，在Swagger UI中，前後端人員能夠直觀預覽並且測試API，方便前後端人員同步開發。         在SpringBoot中整合swa