SpringBoot #1:spring boot集成swagger2 & spring-data-jpa & logging

SpringBoot這個(gè)框架我一直比較喜歡,但迫于沒有時(shí)間整理,一直延續(xù)到現(xiàn)在才來整理框架。這個(gè)文章將是一個(gè)系列,從基礎(chǔ)到復(fù)雜,后面將會不斷推出系列內(nèi)容。所有示例都使用Intellij IDEA編寫,項(xiàng)目構(gòu)建方式選擇了Gradle

本篇文章主要介紹持久層、API文檔、基礎(chǔ)日志的配制。在數(shù)據(jù)持久層上我選擇的是Spring-data-jpa,使用它非常方便,可少寫很多代碼,效率也不錯(cuò),而且還是spring的親兒子;api文檔選擇的是Swagger UI2,Swagger可以自動生成API文檔,在文檔界面上還可以測試,給開發(fā)代來很多方便的;日志這一部分的話就用了比較基礎(chǔ)的東西了,會把運(yùn)行日志輸出到指定文件中,方便維護(hù)時(shí)查找問題。

第一步,創(chuàng)建項(xiàng)目并配制build.gradle文件

通過Intellij IDEA新建一個(gè)Gradle項(xiàng)目,在build.gradle文件中添加項(xiàng)目配制,執(zhí)行一次Refresh all Gradle Projects

apply plugin: 'java'
apply plugin: 'org.springframework.boot'
buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:1.5.2.RELEASE")
    }
}
repositories {
    jcenter()
}
dependencies {
    compile "org.springframework.boot:spring-boot-starter"
    compile 'org.springframework.boot:spring-boot-starter-actuator'
    compile 'org.springframework.boot:spring-boot-starter-web'
    compile 'org.springframework.boot:spring-boot-starter-data-jpa'
    compile 'org.springframework.boot:spring-boot-starter-amqp'
    compile 'org.springframework.boot:spring-boot-starter-integration'
    compile 'org.springframework.integration:spring-integration-file:4.3.5.RELEASE'
    compile 'org.springframework.boot:spring-boot-devtools'
    compile 'mysql:mysql-connector-java'
    compile 'com.google.code.gson:gson:2.8.0'
    compile "io.springfox:springfox-swagger-ui:2.2.2"
    compile "io.springfox:springfox-swagger2:2.2.2"
    testCompile("org.springframework.boot:spring-boot-starter-test")
}

第二步,創(chuàng)建項(xiàng)目文件目錄

  1. 創(chuàng)建java文件夾,在src文件夾下創(chuàng)建文件夾“/main/java”
  2. 創(chuàng)建resources文件夾,在src文件夾下創(chuàng)建文件夾“/main/resources”

第三步,配制application.yml文件

在“src/main/resources/”文件夾下新建文件“application.yml”,并修改其中內(nèi)容。

server:服務(wù)器相關(guān)設(shè)定,在這晨設(shè)定了服務(wù)啟動后的端口號和服務(wù)的根地址
spring.datasource:配制系統(tǒng)數(shù)據(jù)源
spring.jpa:設(shè)置jpa的基礎(chǔ)信息
logging:調(diào)協(xié)日志的信息,logging.file設(shè)置日志文件的存放,可以是“D:\test.logging”這種方式

server:
  port: 8081
  context-path: /api/

spring:
  datasource:
    driverClassName: com.mysql.jdbc.Driver
    url: jdbc:mysql://220.192.001.001:3306/test
    username: root
    password: 123456
    initialSize: 5
    minIdle: 5
    maxActive: 20

  jpa:
    hibernate:
      ddl-auto: update
      naming:
        strategy: org.hibernate.cfg.ImprovedNamingStrategy
    show-sql: true
    database: mysql

logging:
  file: springboot.log

第四步,添加Application.java文件

在項(xiàng)目java包中添加Application.java文件,并初始化內(nèi)容

package leix.lebean.sweb;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.support.SpringBootServletInitializer;
import org.springframework.context.ApplicationContext;
@SpringBootApplication
public class Application extends SpringBootServletInitializer  {
    @Autowired
    ApplicationContext context;
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(Application.class);
    }
    public static void main(String[] args) throws Exception {
        SpringApplication.run(Application.class, args);
    }
}

到這里所有的配制就完成了,剩下的就是數(shù)據(jù)層的使用了,下面介紹一上jpa的使用

創(chuàng)建數(shù)據(jù)實(shí)體

package leix.lebean.sweb.model;
import javax.persistence.*;
import java.io.Serializable;
/**
 * Name:City
 * Description:
 * Author:leix
 * Time: 2017/3/28 14:02
 */
@Entity
@Table(name = "city")
public class City  implements Serializable{
    @Id
    @Column(name = "id")
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private int id;
    @Column(name = "name")
    private String name;
    @Column(name = "state")
    private String state;
    @Column(name = "country")
    private String country;
    public int getId() {return id;}
    public void setId(int id) {this.id = id;}
    public String getName() {return name;}
    public void setName(String name) { this.name = name;}
    public String getState() {return state;}
    public void setState(String state) {this.state = state;}
    public String getCountry() {return country;}
    public void setCountry(String country) {this.country = country;}
}

創(chuàng)建數(shù)據(jù)處理倉庫,jpa的具體語法在這里不詳細(xì)講述了,后面會專門寫一篇文章來介紹

package leix.lebean.sweb.repository;
import leix.lebean.sweb.model.City;
import org.springframework.data.jpa.repository.JpaRepository;
/**
 * Name:CityRepository
 * Description:
 * Author:leix
 * Time: 2017/3/28 14:13
 */
public interface CityRepository extends JpaRepository<City, Integer> {
    City findById(int id);
}

數(shù)據(jù)處理倉庫的調(diào)用

package leix.lebean.sweb.service.impl;
import leix.lebean.sweb.model.City;
import leix.lebean.sweb.repository.CityRepository;
import leix.lebean.sweb.service.CityService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
@Service
@Transactional
public class CityServiceImpl implements CityService {
    @Autowired
    CityRepository cityRepository;
    @Override
    public City findById(int id) {
        return cityRepository.findById(id);
    }
}

源碼看這里:https://github.com/lebean/spring-boot/tree/master/chapter01

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

推薦閱讀更多精彩內(nèi)容