Spring Data JPA进阶+ Swagger

swagger的由来

  • 随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、先后端分离的形态，
    而且前端技术和后端技术在各自的道路上越走越远。
  • 前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，
    swagger就是一款让你更好的书写API文档的框架。

其他API文档工具

  • confluence
  • README.md
  • rap——API文档工具，阿里开发，rap2官网
  • swagger——API文档框架，swagger官网

实例

  • 使用Spring DATA JAP原生方法
  • 解析方法名创建查询的特性
  • 通过注解和JPQL语句创建查询等综合操作，完成对SysUser类中的各种操作

使用方法（选了一种适度封装之后的）

  • 在pom.xml中引入依赖
<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.8.0.RELEASE</version>
</dependency>
  • 在应用主类中增加@EnableSwagger2Doc注解
@SpringBootApplication
@EnableSwagger2Doc
public class Springboot2Swagger2Application {
public static void main(String[] args) {
SpringApplication.run(Springboot2Swagger2Application.class, args);
}
}

swagger.enabled=true
swagger.title=spring-data-jpa module
swagger.description=Starter for swagger 2.x
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=RanRan Tao
swagger.contact.url=https://www.jianshu.com/u/822585e5c69a
swagger.contact.email=16422802@qq.com
swagger.base-package=com.example.book.controller
swagger.base-path=/**
swagger.exclude-path=/error, /ops/**

SysUser实体类

package com.example.book.entity;

import lombok.Data;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import java.io.Serializable;

@Entity
@Data
public class SysUser implements Serializable {
    @Id
    @GeneratedValue
    private Long id;
    @Column(nullable = false)
    private String account;
    private  String password;
    private String nickname;
    private int fans;

    public SysUser(String account, String password, String nickname, int fans) {
        this.account = account;
        this.password = password;
        this.nickname = nickname;
        this.fans = fans;
    }
}

DAO接口 UserRepositry(正确的应该是UserRepository,代码里不小心写错了！)

package com.example.book.dao;

import com.example.book.entity.SysUser;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;

import java.util.List;

public interface UserRepositry extends JpaRepository<SysUser,Long> {
    SysUser findByAccount(String account);
     List<SysUser> findByFansBetween(Integer num1, Integer num2);
     List<SysUser> findByNicknameLike(String nickname);

    @Query("from SysUser u where u.nickname like CONCAT('%',:nickname,'%') order by u.fans desc ")
 List<SysUser> findUsers(@Param("nickname") String nickname);
}

DAO测试类

package com.example.book.dao;

import com.example.book.entity.SysUser;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import javax.annotation.Resource;

import java.util.List;

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserRepositryTest {
    @Resource
    private UserRepositry userRepositry;
@Test
    public void initData(){
    SysUser[] users={
            new SysUser("sdy@qq.com","111","素心若霞",247),
            new SysUser("yjj@qq.com","222","与君绝",283),
            new SysUser("ygkld@qq.com","333","一个快乐的退休俱乐部",1834),
    new SysUser("jrys@qq.com","444","孑然一身",732),
    new SysUser("yxyy@qq.com","555","诗心悠远",539)
    };
    for (int i=0;i<5;i++){
        userRepositry.save(users[i]);
    }
}
    @Test
 public void findOne() {
        SysUser user = userRepositry.findById(42L).get();
         System.out.println(user);
}

@Test
    public void findByFansBetween() {
        List<SysUser> sysUsers =userRepositry.findByFansBetween(200,300);
        sysUsers.forEach(sysUser -> System.out.println(sysUser));

    }

    @Test
    public void findByNicknameLike() {
        List<SysUser> sysUsers=userRepositry.findByNicknameLike("心");
        sysUsers.forEach(sysUser -> System.out.println(sysUser));
    }

    @Test
    public void findByAccount() {
    SysUser sysUser=userRepositry.findByAccount("sdy@qq.com");
        System.out.println(sysUser);
    }

    @Test
  public void findUsers() {
        List<SysUser> users = userRepositry.findUsers("心");
         users.forEach(sysUser -> System.out.println(sysUser)); }

}

Service接口

package com.example.book.service;

import com.example.book.entity.SysUser;

import java.util.List;

public interface UserService {
    SysUser save(SysUser sysUser);

    List<SysUser> getAll();

    SysUser getUser(Long id);
    List<SysUser> getUserfindByNicknameLike(String nickname);
    SysUser getUserfindByAccount(String account);
    List<SysUser> getUsersOrderByFans(String nickname);
}

Service层实现类

package com.example.book.service.Impl;


import com.example.book.dao.UserRepositry;
import com.example.book.entity.SysUser;
import com.example.book.service.UserService;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import javax.transaction.Transactional;
import java.util.List;

@Service
public class UserServiceImpl implements UserService {
    @Resource
    private UserRepositry userRepositry;

    @Override
    @Transactional
    public SysUser save(SysUser sysUser) {
        return userRepositry.save(sysUser);
    }

    @Override
    public List<SysUser> getAll() {
        return userRepositry.findAll();
    }

    @Override
 public SysUser getUser(Long id) {
        return userRepositry.findById(id).get();
        }

    @Override
    public List<SysUser> getUserfindByNicknameLike(String nickname){
        return userRepositry.findByNicknameLike(nickname);
    }
@Override
    public SysUser getUserfindByAccount(String account){
        return userRepositry.findByAccount(account);
}
    @Override
 public List<SysUser> getUsersOrderByFans(String nickname) {
        return userRepositry.findUsers(nickname);
    }
}

Controller

package com.example.book.controller;

import com.example.book.entity.SysUser;
import com.example.book.service.UserService;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;
import javax.persistence.GeneratedValue;
import java.util.List;

@RestController
@RequestMapping(value = "/user")
public class UserController {
    @Resource
    private UserService userService;
    @GetMapping(value = "/all")
    public List<SysUser> getAll(){
        return userService.getAll();
    }
    @GetMapping("/{id}")
 public SysUser getUser(@PathVariable Long id) {
        return userService.getUser(id);
    }

    @GetMapping(value = "/{nickname}")
    public List<SysUser> getUserfindByNicknameLike(String nickname){
        return userService.getUserfindByNicknameLike(nickname);
    }
    @GetMapping(value = "/{account}")
    public SysUser getUserfindByAccount(String account){
        return  userService.getUserfindByAccount(account);
    }
    @GetMapping("/order")
    public List<SysUser> getUsersOrderByFans(@RequestParam String nickname) {
        return userService.getUsersOrderByFans(nickname);
        }
}

使用swagger生成在线接口文档

  • 所有方法的截图


    image.png

  • 以getall方法获取所有信息的截图为例


    image.png

使用swagger测试接口比利用postman更美观方便哦！

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,080评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,422评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,630评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,554评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,662评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,856评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,014评论 3赞 408
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,752评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,212评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,541评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,687评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,347评论 4赞 331
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,973评论 3赞 315
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,777评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,006评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,406评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,576评论 2赞 349

推荐阅读更多精彩内容