首頁 > 軟體

如何基於Springboot完成新增員工功能並設定全域性例外處理器

2022-11-27 14:00:51

1. 新增員工

1.1 需求分析

後臺系統中可以管理員工資訊,通過新增員工來新增後臺系統使用者。點選[新增員工]按鈕跳轉到新增頁面,如下

當填寫完表單資訊, 點選"儲存"按鈕後, 會提交該表單的資料到伺服器端, 在伺服器端中需要接受資料, 然後將資料儲存至資料庫中。

1.2 資料模型

新增員工,其實就是將我們新增頁面錄入的員工資料插入到employee表。employee表中的status欄位已經設定了預設值1,表示狀態正常。

 需要注意,employee表中對username欄位加入了唯一約束,因為username是員工的登入賬號,必須是唯一的。

1.3 程式執行流程

A. 點選"儲存"按鈕, 頁面傳送ajax請求,將新增員工頁面中輸入的資料以json的形式提交到伺服器端, 請求方式POST, 請求路徑 /employee

B. 伺服器端Controller接收頁面提交的資料並呼叫Service將資料進行儲存

C. Service呼叫Mapper運算元據庫,儲存資料

1.4 程式碼實現

package com.itheima.reggie.controller;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.itheima.reggie.common.R;
import com.itheima.reggie.entity.Employee;
import com.itheima.reggie.service.EmployeeService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.util.DigestUtils;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import java.time.LocalDateTime;

@Slf4j
@RestController
@RequestMapping("/employee")
public class EmployeeController {
    @Autowired
    private EmployeeService employeeService;

    @PostMapping("/login")
    public R<Employee> login(HttpServletRequest request, @RequestBody Employee employee){
    /**@Description: 員工登陸
     * @param @RequestBody 傳入的是json 故需要將其轉化為實體類,json中的類名與實體類名對應才可以封裝
     *          A. 由於需求分析時, 我們看到前端發起的請求為post請求, 所以伺服器端需要使用註解 @PostMapping
     *          B. 由於前端傳遞的請求引數為json格式的資料, 這裡使用Employee物件接收, 但是將json格式資料封裝到實體類中, 在形參前需要加註解@RequestBody
     * @return com.itheima.reggie.common.R<com.itheima.reggie.entity.Employee>
     * @version v1.0
     * @author LiBiGo
     * @date 2022/8/12 11:32
     */
        //  ①. 將頁面提交的密碼password進行md5加密處理, 得到加密後的字串
        String password = employee.getPassword();
        password = DigestUtils.md5DigestAsHex(password.getBytes());
        //  ②. 根據頁面提交的使用者名稱username查詢資料庫中員工資料資訊
        LambdaQueryWrapper<Employee> queryWrapper = new LambdaQueryWrapper<>();
        queryWrapper.eq(Employee::getUsername,employee.getUsername());
        Employee emp = employeeService.getOne(queryWrapper); //在資料庫中使用者名稱是唯一的,所以可以用getone()
        //  ③. 如果沒有查詢到, 則返回登入失敗結果
        if (emp == null){
            return R.error("使用者名稱不存在");
        }
        //  ④. 密碼比對,如果不一致, 則返回登入失敗結果
        if(!emp.getPassword().equals(password)){
            return R.error("密碼失敗");
        }
        //  ⑤. 檢視員工狀態,如果為已禁用狀態,則返回員工已禁用結果
        if(emp.getStatus() == 0){
            return R.error("賬戶已禁用");
        }
        //  ⑥. 登入成功,將員工id存入Session, 並返回登入成功結果
        request.getSession().setAttribute("employee",emp.getId());
        return R.success(emp);
    }

    @PostMapping("/logout")
    public R<String> logout(HttpServletRequest request){
    /**@Description:  /employee/logout 員工退出
     * @author LiBiGo
     * @date 2022/8/12 12:09
     */
        //  清理Session中儲存的當前登入員工的id
        request.getSession().removeAttribute("employee");
        //  返回結果
        return R.success("退出成功");
    }

    @PostMapping
    public R<String> save(HttpServletRequest request,@RequestBody Employee employee){
        /**@Description: 用於儲存使用者員工資訊。
         *
         * B. 在組裝員工資訊時, 還需要封裝建立時間、修改時間,建立人、修改人資訊(從session中獲取當前登入使用者)。
         * @author LiBiGo
         * @date 2022/8/12 17:25
         */
        log.info("新增員工,員工資訊:{}",employee.toString());
        // A. 在新增員工時,設定初始密碼,需要進行MD5加密處理
        employee.setPassword(DigestUtils.md5DigestAsHex("123456".getBytes()));
        // B. 在組裝員工資訊時, 需封裝建立時間、修改時間,建立人、修改人資訊(從session中獲取當前登入使用者)。
        employee.setCreateTime(LocalDateTime.now());
        employee.setUpdateTime(LocalDateTime.now());

        //獲得當前登入員工使用者的id
        Long empId = (Long) request.getSession().getAttribute("employee");

        employee.setCreateUser(empId); // 建立員工資訊的人
        employee.setUpdateUser(empId); // 最後一次更新資訊的人

        employeeService.save(employee); // 因為employeeService繼承了,所以不用寫,直接用
        log.info("新增員工成功");
        return R.success("新增員工成功");
    }
}

2 全域性例外處理

2.1 新增員工存在的問題

當我們在測試中,新增使用者時, 輸入了一個已存在的使用者名稱時,前端介面出現錯誤提示資訊:

​而此時,伺服器端已經報錯了, 報錯資訊如下:

​出現上述的錯誤, 主要就是因為在 employee 表結構中,我們針對於username欄位,建立了唯一索引,新增重複的username資料時,違背該約束,就會報錯。但是此時前端提示的資訊並不具體,使用者並不知道是因為什麼原因造成的該異常,我們需要給使用者提示詳細的錯誤資訊 。

2.2 全域性例外處理思路

我們需要對程式中可能出現的異常進行捕獲,通常有兩種處理方式:

A. 在Controller方法中加入 try...catch 進行異常捕獲

形式如下:

 如果採用這種方式,雖然可以解決,但是存在弊端,需要我們在儲存其他業務資料時,也需要在Controller方法中加上try...catch進行處理,程式碼冗餘,不通用。

B. 使用例外處理器進行全域性異常捕獲

採用這種方式來實現,只需要在專案中定義一個通用的全域性例外處理器,就可以解決專案的所有異常。

2.3 全域性例外處理器

在專案中自定義一個全域性例外處理器,在例外處理器上加上註解 @ControllerAdvice,可以通過屬性annotations指定攔截哪一類的Controller方法。 並在例外處理器的方法上加上註解 @ExceptionHandler 來指定攔截的是那一型別的異常。

例外處理方法邏輯:

  • 指定捕獲的異常型別為 SQLIntegrityConstraintViolationException
  • 解析異常的提示資訊, 獲取出是那個值違背了唯一約束
  • 組裝錯誤資訊並返回

2.4 全域性例外處理器程式碼實現

package com.itheima.reggie.common;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import java.sql.SQLIntegrityConstraintViolationException;
/**
 * Description: 全域性例外處理器
 */

@ControllerAdvice(annotations = {RestController.class, Controller.class})// 處理@RestController、@Controller的函數異常 //指定攔截那些型別的控制器;
@ResponseBody   //將方法的返回值 R 物件轉換為json格式的資料, 響應給頁面;
@Slf4j
public class GlobalExceptionHandler {
    /**@Description: 例外處理方法
     * @author LiBiGo
     * @date 2022/8/12 17:46
     */
    @ExceptionHandler(SQLIntegrityConstraintViolationException.class) // 處理指定異常類
    public R<String> exceptionHandler(SQLIntegrityConstraintViolationException ex){
        log.error(ex.getMessage());
        //Duplicate entry '299067' for key 'idx_username'
        if(ex.getMessage().contains("Duplicate entry")){
            String[] split = ex.getMessage().split(" "); //提取重複欄位,即哪個使用者名稱重複 從0開始第2個即為使用者名稱
            String msg = split[2] + "已存在";
            return R.error(msg);
        }
        return R.error("未知錯誤");
    }
}

2.5 測試

全域性例外處理器編寫完畢後將專案重啟, 完畢之後直接存取管理系統首頁, 點選 "員工管理" 頁面中的 "新增員工" 按鈕。當新增使用者時, 輸入了一個已存在的使用者名稱時,前端介面出現如下錯誤提示資訊:

總結

到此這篇關於如何基於Springboot完成新增員工功能並設定全域性例外處理器的文章就介紹到這了,更多相關Springboot新增員工並設定全域性異常內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com