SpringBoot之路(二)之Web進(jìn)階

前言

昨天 -> 帶女朋友和小表弟去了動(dòng)物園，看了《全球風(fēng)暴》電影。
今天 -> 學(xué)習(xí)了慕課網(wǎng)的Spring Boot進(jìn)階之Web進(jìn)階的視頻和該項(xiàng)目 項(xiàng)目源碼，看了一個(gè)基于Spring Boot的API、RESTful API項(xiàng)目種子（骨架）的博客。
明天 -> 準(zhǔn)備看純潔的微笑的博客，更深入的學(xué)習(xí)Spring Boot相關(guān)知識(shí)。

該學(xué)習(xí)筆記Demo項(xiàng)目地址是Spring Boot 簡(jiǎn)單實(shí)例Demo

表單驗(yàn)證

  • 1.數(shù)據(jù)驗(yàn)證不僅要在前端進(jìn)行驗(yàn)證，而且還要在后臺(tái)進(jìn)行驗(yàn)證。防君子也防小人。我們通過 @Min(value = XXX, message = "XXX")可以具體到Model類的某一個(gè)字段進(jìn)行限制。value是設(shè)置最小值, message中的內(nèi)容是如果不滿足最小值的情況下，需要輸出的消息。
@Entity
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Girl {

    @Id
    @GeneratedValue
    private Integer id;

    private String name;

    @Min(value = 18, message = "Minor girls are prohibited from entering")
    private Integer age;

    private String cupSize;

}

另外我們可以用lombok來簡(jiǎn)化消除model類中的setter,getter,constructor方法。常用的注解：@Data，@NoArgsConstructor， @AllArgsConstructor 。
@Data提供所有屬性的setter和getter方法，此外還可以提供了equals，hashCode, toString()方法。
@NoArgsConstructor注解在類上，提供了一個(gè)無參的構(gòu)造方法。
@AllArgsConstructor注解在類上，提供了一個(gè)有參的構(gòu)造方法。

pom.xml文件配置如下。

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    1. @Valid注解會(huì)驗(yàn)證Girl類中的age屬性是否滿足我們定義的驗(yàn)證條件。我們可以調(diào)用bindingResult.hasErrors()方法來判斷是否驗(yàn)證成功，內(nèi)部實(shí)現(xiàn)是判斷存放錯(cuò)誤信息的list集合是否為空。
private final List<ObjectError> errors = new LinkedList();
public boolean hasErrors() {
        return !this.errors.isEmpty();
    }

數(shù)據(jù)驗(yàn)證失敗后，我們加上需要處理的業(yè)務(wù)邏輯就行了。

    @PostMapping(value = "/girls")
    public Girl girlAdd(@Valid  Girl girl, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            System.out.println(bindingResult.getFieldError().getDefaultMessage());
            return null;
        }
        return girlRepository.save(girl);
    }
  • 3.啟動(dòng)應(yīng)用，使用PostMan測(cè)試API，控制臺(tái)輸出了我們驗(yàn)證信息。
image.png

AOP處理請(qǐng)求

什么是AOP?
  • AOP的英文名是Aspect Oriented Programming。AOP是一種編程范式，與語言無關(guān)，是一種程序設(shè)計(jì)思想。AOP面向切面編程將程序中的交叉業(yè)務(wù)邏輯（比如安全，日志，事務(wù)），封裝成一個(gè)切面，然后注入到目標(biāo)業(yè)務(wù)邏輯中。
  • 實(shí)現(xiàn)AOP的技術(shù)：
    • 采用動(dòng)態(tài)代理的技術(shù)，利用裁取消息的方式，對(duì)該消息進(jìn)行裝飾，以取代原有對(duì)象行為的執(zhí)行。
    • 是采用靜態(tài)的方式，引入特定的語法創(chuàng)建方面，從而使得編譯器可以在編譯期間織入有關(guān)方面的代碼。
什么是JoinPoint?
  • JoinPoint顧名思義就是連接點(diǎn)，是程序運(yùn)行期間中的某一個(gè)階段點(diǎn)，比如方法的調(diào)用，異常的拋出等。
什么是PointCut?
  • PointCut是JoinPoint的集合，它是程序中需要注入Advice中的位置集合，指明Advice需要在什么條件下才能被觸發(fā)。
什么是Advice?
  • 它是某個(gè)連接點(diǎn)所采用的處理邏輯，也就是向連接點(diǎn)注入的代碼。比如：輸出的日志就是一個(gè)Advice。
什么是Advisor？
  • Advisor是PointCut和Advice的配置器，它包括PointCut和Advice，是將Advice注入程序中PointCut位置的代碼。
模擬出網(wǎng)絡(luò)請(qǐng)求中輸出相關(guān)日志的功能
    1. 流程肯定是這樣的：收到HttpRequest請(qǐng)求 -> 記錄請(qǐng)求 -> 處理網(wǎng)絡(luò)請(qǐng)求 -> 生成HttpResponse -> 記錄回復(fù)。
    1. 我們先定義一個(gè)HttpAspect.java。使用@Aspect和@Component聲明這是一個(gè)切面并在Spring.xml注冊(cè)這個(gè)切面。首先用 @Pointcut("execution(* girl.controller..*.*(..))")注解這個(gè)pointCut()方法，代表這個(gè)方法是一個(gè)PointCut。這個(gè)注解的意思時(shí)定義在girl.controller包或者子包里的任何類中的任意方法的執(zhí)行。
    • 第一個(gè) * ：通配所有的返回類型。
    • 第二個(gè) * ： 通配girl.controller包和girl.controller子包下所有的類。
    • 第三個(gè) * ： 通配所有的方法。
    • 最后一個(gè) * ： 代表方法中所有的參數(shù)。
      @Before("pointCut()")代表調(diào)用方法前的階段，@After("pointCut()")代表調(diào)用方法后的階段， @AfterReturning(returning = "object", pointcut = "pointCut()")代表執(zhí)行完方法，需要return參數(shù)的階段。
    1. 同時(shí)我們也要打印Log，記住要引進(jìn)import org.slf4j.Logger;這個(gè)包，別引進(jìn)錯(cuò)了包。Log優(yōu)先級(jí)如下： DEBUG > INFO > WARN > ERROR。HttpAspect類代碼下:
@Aspect
@Component
public class HttpAspect {

    private static final Logger _log = LoggerFactory.getLogger(HttpAspect.class);

    @Pointcut("execution(* girl.controller..*.*(..))")
    public void pointCut() {

    }

    @Before("pointCut()")
    public void doBefore(JoinPoint joinPoint) {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        _log.info("url = {}", request.getRequestURL());
        _log.info("method = {}", request.getMethod());
        _log.info("ip = {}", request.getRemoteAddr());
        _log.info("class_method = {}", joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        _log.info("args = {}", joinPoint.getArgs());
    }

    @After("pointCut()")
    public void  doAfter() {
        _log.info("after");
    }

    @AfterReturning(returning = "object", pointcut = "pointCut()")
    public void doAtferReturning(Object object) {
        _log.info("response = {}", object);
    }
}
    1. 啟動(dòng)應(yīng)用，我們用PostMan測(cè)試API，觀看Console輸出的結(jié)果。和我們預(yù)期的是一樣的，輸出了網(wǎng)絡(luò)請(qǐng)求相關(guān)的日志。
image.png

全局異常處理

  • 1.定義響應(yīng)結(jié)果Result類，我們可以看到聚合接口官網(wǎng)提供的接口，數(shù)據(jù)返回的格式是這樣子的。

image.png

所以這個(gè)類有code,msg,data這三個(gè)屬性。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Result {
    private Integer code;
    private String msg;
    private Object data;
}
  • 2.接著我們需要再定義一個(gè)響應(yīng)結(jié)果狀態(tài)碼的ResultCode類,為了標(biāo)識(shí)每一個(gè)狀態(tài)碼對(duì)應(yīng)著錯(cuò)誤的信息。我們可以使用枚舉的形式。
public enum  ResultCode {
    UNKNOW_ERROR(-1, "unknow error"),
    SUCCESS(0, "success"),
    UNAUTHORIZED(401, "no authorized"),
    NOT_FOUND(404, "not found"),
    INTERNAL_SERVER_ERROR(500, "internal server error"),
    LOLITA(1, "lolita"),
    ROYAL_SISTER(2, "royal sister"),
    YOUNG_WOMAN(3, "young woman"),
    AUNT(4, "aunt");


    private Integer code;
    private String msg;

    ResultCode(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}
  • 3.接著我們?cè)诙x一個(gè)響應(yīng)結(jié)果生成的工具類ResultGenerator,運(yùn)用了靜態(tài)工廠方法，提供success，errror()方法去創(chuàng)建相應(yīng)的響應(yīng)結(jié)果result類，使代碼變得簡(jiǎn)潔。
public class ResultGenerator {

    public static Result success() {
        return success(null);
    }

    public static Result success(Object object) {
        Result result = new Result();
        result.setCode(ResultCode.SUCCESS.getCode());
        result.setMsg(ResultCode.SUCCESS.getMsg());
        result.setData(object);
        return result;
    }

    public static Result error(ResultCode resultCode) {
        Result result = new Result();
        result.setCode(resultCode.getCode());
        result.setMsg(resultCode.getMsg());
        result.setData(null);
        return  result;
    }
}

靜態(tài)工廠的優(yōu)點(diǎn)：

  • 它們都有名稱。比如ResultGenerator.success()，很顯而易見。

  • 不必每次調(diào)用success(),error()方法時(shí)都創(chuàng)建一個(gè)ResultGenerator類的實(shí)例。

  • 它們可以返回原返回類型的任何子類型的對(duì)象。

  • 在創(chuàng)建參數(shù)化類型實(shí)例的時(shí)候，它們使得代碼變得更加簡(jiǎn)潔。比如類型推導(dǎo)。

    1. 我們接著定義一個(gè)ExceptionHandler.java。使用@ControllerAdvice，聲明這個(gè)類是可以全局處理異常的類。使用@org.springframework.web.bind.annotation.ExceptionHandler(value = Exception.class)注解到具體的方法上去處理異常。
@ControllerAdvice
public class ExceptionHandler {
    private static final Logger _log = LoggerFactory.getLogger(ExceptionHandler.class);


    @org.springframework.web.bind.annotation.ExceptionHandler(value = Exception.class)
    @ResponseBody
    public Result handlerException(Exception e) {
        if (e instanceof GirlException) {
            return ResultGenerator.error(((GirlException) e).getResultCode());
        } else {
            _log.error("unknow exception = {}", e.getMessage());
            return ResultGenerator.error(ResultCode.UNKNOW_ERROR);
        }
    }
}
    1. 自定義GirlException.java 
public class GirlException extends RuntimeException {
    private Integer code;
    private ResultCode resultCode;

    public GirlException(ResultCode resultCode) {
        super(resultCode.getMsg());
        this.resultCode = resultCode;
        this.code = resultCode.getCode();
    }

    public Integer getCode() {
        return code;
    }

    public ResultCode getResultCode() {
        return resultCode;
    }
}
    1. 在GirlService類中可以定義一個(gè)方法，通過傳入一個(gè)女生的年齡，返回她所處于的階段。流程： 我們通過傳入id，查詢到具體的Girl類。年齡在(0,18)是蘿莉，【18,30）是御姐，【30,35）是少婦，其他年齡段的統(tǒng)稱大媽。我們返回?cái)?shù)據(jù)的形式是通過拋出異常，異常向上拋出。
 @GetMapping(value = "/girls/getAge/{id}")
    public void getAge(@PathVariable("id") Integer id) throws GirlException {
        girlService.getAge(id);
    }

GirlController調(diào)用getAge()方法，不處理GirlException異常，繼續(xù)向上拋出異常。那么ExceptionHandler就能處理這個(gè)異常了，通過判斷異常的類型，返回相應(yīng)的Result響應(yīng)結(jié)果。

public void getAge(Integer id) throws GirlException {
        Girl girl = girlRepository.findOne(id);
        int age = girl.getAge();

        if (age > 0 && age < 18) {
            throw new GirlException(ResultCode.LOLITA);
        } else if (age >= 18 && age < 30) {
            throw new GirlException(ResultCode.ROYAL_SISTER);
        } else if (age >= 30 && age < 35) {
            throw new GirlException(ResultCode.YOUNG_WOMAN);
        } else {
            throw new GirlException(ResultCode.AUNT);
        }
    }
  • 7 啟動(dòng)應(yīng)用，調(diào)試API，http://localhost:8081/girl/girls/getAge/1，輸出結(jié)果。顯而易見，id=1對(duì)應(yīng)著小妹妹的年齡為15, 15在（0,18）區(qū)間段，應(yīng)該輸出“蘿莉”。
image.png
image.png

單元測(cè)試

每一個(gè)合格的程序員在寫完相應(yīng)的業(yè)務(wù)邏輯后，不可避免的需要去寫Unit Test Case。 Dao層，Service層，Controller層要100%覆蓋到，不要遺漏任何一個(gè)方法。

  • 1 把光標(biāo)移動(dòng)GirlController類，使用快捷鍵Ctrl + Shift + T去創(chuàng)建測(cè)試單元
image.png
    1. 我們需要選擇測(cè)試的方法，最好全部勾住。
image.png
    1. 選擇完畢后，Intelli J會(huì)幫我們創(chuàng)建好測(cè)試的類，我們只需要在類上加上相應(yīng)的注解就行了。Dao層和Service層加上@SpringBootTest @RunWith(SpringRunner.class)即可。
@SpringBootTest
@RunWith(SpringRunner.class)
@AutoConfigureMockMvc
public class GirlControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void girlFindOne() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.get("/girls/1"))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.content().string("abc"));
    }

}

Controller層我們還需要加上額外的@AutoConfigureMockMvc注解，因?yàn)槲覀円M請(qǐng)求去測(cè)試我們的Controller類中的方法，所以需要配置MockMvc，使用@AutoConfigureMockMvc。

@SpringBootTest
@RunWith(SpringRunner.class)
public class GirlServiceTest {

    @Autowired
    private GirlService girlService;

    @Test
    public void findOne() throws Exception {
        Girl girl = girlService.findOne(1);
        Assert.assertEquals(new Integer(15), girl.getAge());
    }

}
    1. 我們可以去下斷言Assert和andExpect，比如這個(gè)請(qǐng)求返回的狀態(tài)碼是否是200，請(qǐng)求返回的內(nèi)容是否與我們預(yù)期的保持一致等等。然后去Ctrl +Shift + F10 跑Test Case。
image.png
    1. 綠色代表成功，紅色代表失敗。因?yàn)?code>"/girls/1"返回的結(jié)果 本來就不等于“abc”，斷言失敗。我們?nèi)サ?code>.andExpect(MockMvcResultMatchers.content().string("abc"))，再去run一下Test Case，查看結(jié)果，很顯然是成功的。
image.png
如果TestCase很多，我們需要像這樣一個(gè)一個(gè)的跑嗎？

很顯然，答案是不需要的。我們?cè)?code>girl項(xiàng)目的根目錄打開命令窗口，輸入 mvn clean package，我們?cè)诖虬臅r(shí)候，會(huì)自動(dòng)跑完Test Case，輸出測(cè)試結(jié)果。因?yàn)槲覄偛庞旨由狭?code>andExpect(MockMvcResultMatchers.content().string("abc"))，會(huì)導(dǎo)致一個(gè)Test Case失敗。

image.png
image.png

如果我們?cè)诖虬臅r(shí)候，不想去跑Test Case，因?yàn)榕?code>Case會(huì)影響打包的速度或者有時(shí)候跑Case會(huì)發(fā)生一些未知的錯(cuò)誤。那么我們只需要在打包的時(shí)候輸入mvn clean package -Dmaven.test.skip=true即可，觀看結(jié)果。完美跳過Test Case，美滋滋Build Success。

image.png

注意事項(xiàng)

  • DemoApplication.java是Spring Boot的應(yīng)用入口，這個(gè)類應(yīng)該和其他類所在的目錄應(yīng)該保持同級(jí)，不然調(diào)用SpringApplication.run(DemoApplication.class, args)方法，啟動(dòng)應(yīng)用成功，但是dispatcherServlet映射url`會(huì)發(fā)生錯(cuò)誤。
image.png
  • 全局處理異常的時(shí)候，需要返回json格式，需要加上注解@ResponseBody，比如我就經(jīng)常忘記這個(gè)注解。寫@RestController寫習(xí)慣了！

尾言

從S1末到S7了,從高一到明年大學(xué)畢業(yè)，時(shí)光荏苒。昨天RNG輸了，今天WE輸了?？墒俏业那啻阂呀?jīng)如煙了。加油LPL，百煉成鋼，心之所向，風(fēng)雨兼程。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容