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

SpringBoot这个框架我一直比较喜欢,但迫于没有时间整理,一直延续到现在才来整理框架。这个文章将是一个系列,从基础到复杂,后面将会不断推出系列内容。所有示例都使用Intellij IDEA编写,项目构建方式选择了Gradle

本篇文章主要介绍持久层、API文档、基础日志的配制。在数据持久层上我选择的是Spring-data-jpa,使用它非常方便,可少写很多代码,效率也不错,而且还是spring的亲儿子;api文档选择的是Swagger UI2,Swagger可以自动生成API文档,在文档界面上还可以测试,给开发代来很多方便的;日志这一部分的话就用了比较基础的东西了,会把运行日志输出到指定文件中,方便维护时查找问题。

第一步,创建项目并配制build.gradle文件

通过Intellij IDEA新建一个Gradle项目,在build.gradle文件中添加项目配制,执行一次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")
}

第二步,创建项目文件目录

  1. 创建java文件夹,在src文件夹下创建文件夹“/main/java”
  2. 创建resources文件夹,在src文件夹下创建文件夹“/main/resources”

第三步,配制application.yml文件

在“src/main/resources/”文件夹下新建文件“application.yml”,并修改其中内容。

server:服务器相关设定,在这晨设定了服务启动后的端口号和服务的根地址
spring.datasource:配制系统数据源
spring.jpa:设置jpa的基础信息
logging:调协日志的信息,logging.file设置日志文件的存放,可以是“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文件

在项目java包中添加Application.java文件,并初始化内容

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);
    }
}

到这里所有的配制就完成了,剩下的就是数据层的使用了,下面介绍一上jpa的使用

创建数据实体

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;}
}

创建数据处理仓库,jpa的具体语法在这里不详细讲述了,后面会专门写一篇文章来介绍

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);
}

数据处理仓库的调用

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,907评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,546评论 1 289
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,705评论 0 238
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,624评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,940评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,371评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,672评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,396评论 0 195
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,069评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,350评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,876评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,243评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,847评论 3 231
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,004评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,755评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,378评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,266评论 2 259

推荐阅读更多精彩内容