【后端架构完善与接口开发】004-通用返回类、封装请求参数

訾博ZiBo

发布于 2025-01-06 18:37:25

16600

代码可运行

文章被收录于专栏：全栈开发工程师全栈开发工程师

运行总次数：0

代码可运行

5、通用返回类

第一步：新建包 resp ，创建 CommonResp 类

package com.zibo.wiki.resp;

public class CommonResp<T> {

    /**
     * 业务上的成功或失败
     */
    private boolean success = true;

    /**
     * 返回信息
     */
    private String message;

    /**
     * 返回泛型数据，自定义类型
     */
    private T content;

    public boolean getSuccess() {
        return success;
    }

    // 我把它改造成了链式写法
    public CommonResp<T> setSuccess(boolean success) {
        this.success = success;
        return this;
    }

    public String getMessage() {
        return message;
    }

    // 我把它改造成了链式写法
    public CommonResp<T> setMessage(String message) {
        this.message = message;
        return this;
    }

    public T getContent() {
        return content;
    }

    // 我把它改造成了链式写法
    public CommonResp<T> setContent(T content) {
        this.content = content;
        return this;
    }

    @Override
    public String toString() {
        final StringBuffer sb = new StringBuffer("ResponseDto{");
        sb.append("success=").append(success);
        sb.append(", message='").append(message).append('\'');
        sb.append(", content=").append(content);
        sb.append('}');
        return sb.toString();
    }
}

第二步：改造 EBookController

package com.zibo.wiki.controller;

import com.zibo.wiki.domain.Ebook;
import com.zibo.wiki.resp.CommonResp;
import com.zibo.wiki.serivce.EBookService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class EBookController {

    @Autowired
    private EBookService eBookService;

    @GetMapping("ebook/list")
    public CommonResp<List<Ebook>> list() {
        return new CommonResp<List<Ebook>>().setContent(eBookService.list());
    }
}

第三步：运行测试

6、封装请求参数

实现模糊擦或查询！

第一步：修该 EBookController

package com.zibo.wiki.controller;

import com.zibo.wiki.domain.Ebook;
import com.zibo.wiki.resp.CommonResp;
import com.zibo.wiki.serivce.EBookService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class EBookController {

    @Autowired
    private EBookService eBookService;

    @GetMapping("ebook/list")
    public CommonResp<List<Ebook>> list(String name) {
        return new CommonResp<List<Ebook>>().setContent(eBookService.list(name));
    }
}

第二步：修改 EBookSerivice

package com.zibo.wiki.serivce;

import com.zibo.wiki.domain.Ebook;
import com.zibo.wiki.domain.EbookExample;
import com.zibo.wiki.mapper.EbookMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class EBookService {

    @Autowired
    private EbookMapper ebookMapper;

    public List<Ebook> list(String name){
        EbookExample ebookExample = new EbookExample();
        // 查询条件
        EbookExample.Criteria criteria = ebookExample.createCriteria();
        criteria.andNameLike("%" + name + "%");
        return ebookMapper.selectByExample(ebookExample);
    }

}

第三步：修改 ebook.http

GET http://localhost:8080/ebook/list?name=Spring
Accept: application/json

###

第四步：运行测试

第五步、将传进来的参数封装成类

新建 req 包，再新建 EbookReq 类

package com.zibo.wiki.req;

public class EbookReq {
    private Long id;

    private String name;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append(getClass().getSimpleName());
        sb.append(" [");
        sb.append("Hash = ").append(hashCode());
        sb.append(", id=").append(id);
        sb.append(", name=").append(name);
        sb.append("]");
        return sb.toString();
    }
}

第六步：修改 EbookController

package com.zibo.wiki.serivce;

import com.zibo.wiki.domain.Ebook;
import com.zibo.wiki.domain.EbookExample;
import com.zibo.wiki.mapper.EbookMapper;
import com.zibo.wiki.req.EbookReq;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class EBookService {

    @Autowired
    private EbookMapper ebookMapper;

    public List<Ebook> list(EbookReq req){
        EbookExample ebookExample = new EbookExample();
        // 查询条件
        EbookExample.Criteria criteria = ebookExample.createCriteria();
        criteria.andNameLike("%" + req.getName() + "%");
        return ebookMapper.selectByExample(ebookExample);
    }

}

第七步：修改 EBookService

package com.zibo.wiki.serivce;

import com.zibo.wiki.domain.Ebook;
import com.zibo.wiki.domain.EbookExample;
import com.zibo.wiki.mapper.EbookMapper;
import com.zibo.wiki.req.EbookReq;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class EBookService {

    @Autowired
    private EbookMapper ebookMapper;

    public List<Ebook> list(EbookReq req){
        EbookExample ebookExample = new EbookExample();
        // 查询条件
        EbookExample.Criteria criteria = ebookExample.createCriteria();
        criteria.andNameLike("%" + req.getName() + "%");
        return ebookMapper.selectByExample(ebookExample);
    }

}