如何让自己的代码更优雅更简洁 之BaseController

本文介绍了如何通过创建通用的返回类Result和BaseController来规范化后端API的响应,提高代码可读性和与前端的对接效率。BaseController中包含了成功与错误的快捷返回方法,使得控制器代码更加简洁。示例展示了具体的方法实现和Postman的返回结果,以及实际应用中的简洁Controller代码,帮助开发者提升项目开发效率。
摘要由CSDN通过智能技术生成

         大家写controller的时候是不是都需要返回一个结果给前端呢,成功与否,成功后提示的消息,后端出错响应给前端的消息 或者是说 所携带的数据等等,这里咱们可以找到一个共同点,就是都需要这么一个返回值,对于这些返回值为了更好和前端对接,也让咱们的代码可读性更强一点,一般我们都会写一个公共的返回类,用于规范返回结果,下面是通用的返回结果类:

import lombok.Data;

/**
 * @author: shenwang
 * Date: 2021/5/24
 */
@Data
public class Result {
    /**
     * 结果 (true、false)
     */
    private boolean flag;
    /**
     * 消息提醒
     */
    private String message;
    /**
     * 所携带的数据
     */
    private Object data;

    public Result(){}

    public Result(boolean flag,String message){
        this.flag=flag;
        this.message=message;
    }
    public Result(boolean flag,Object data){
        this.flag=flag;
        this.data=data;
    }
    public Result(boolean flag,String message,Object data){
        this.flag=flag;
        this.data=data;
        this.message=message;
    }

}

然后咱们再去写BaseController

/**
 * web层通用数据处理
 * @author: shenwang
 * Date: 2021/11/22
 */
public class BaseController {
    /**
     * 日志记录
     */
    private static Logger logger= LoggerFactory.getLogger(BaseController.class);

    /**
     * 将前台传递过来的日期格式的字符串,自动转化为Date类型
     */
    @InitBinder
    public void initBinder(WebDataBinder binder)
    {
        // Date 类型转换
        binder.registerCustomEditor(Date.class, new PropertyEditorSupport()
        {
            @Override
            public void setAsText(String text)
            {
                setValue(DateUtils.parseDate(text));
            }
        });
    }

    /**
     * 成功,带消息返回
     * @param message
     * @return
     */
    public Result success(String message){
        return new Result(true,message);
    }

    /**
     * 成功,带消息和数据返回
     * @param message
     * @param data
     * @return
     */
    public Result success(String message,Object data){
        return new Result(true,message,data);
    }

    /**
     * 错误 带消息返回
     * @param message
     * @return
     */
    public Result error(String message){
        return new Result(false,message);
    }

    /**
     * 错误 带消息和数据返回
     * @param message
     * @param data
     * @return
     */
    public Result error(String message,Object data){
        return new Result(false,message,data);
    }
}

咱们写controller的时候就可以去继承咱们的BaseController

 紧接着咱们就可以使用超级简洁的代码去返回咱们的结果啦!

 看一个方法的代码 就这么简洁,现在让咱们来看下postman的返回结果吧

 最后咱们再来看一下咱们整体controller的代码吧!

看,多简洁,学废了吗,如果对你有帮助 就点个赞分享给其他小伙伴一起学习吧~

`BaseController` 在不同的框架或应用中可能有不同的含义和用途。在Web开发中,特别是在使用.NET MVC或类似框架的环境中,`BaseController` 通常是指一个基类控制器,用于封装公共的逻辑和属性,这样所有的子控制器都可以继承这个基类来复用代码。 例如,在ASP.NET MVC中,`BaseController` 可能会包含如用户认证、错误处理、日志记录等在多个控制器之间共享的方法和属性。这样,开发者就可以在`BaseController`中编一次代码,然后让所有的子控制器都继承这些功能,从而减少重复代码,并保持代码的一致性。 在其他的应用中,`BaseController` 可能会被用作一个通用的处理层,提供对数据库、服务层或其他基础资源的访问接口。 具体到源码层面,`BaseController` 的实现会依赖于你正在使用的具体框架和业务需求。在源码中,你可能会看到类似以下结构的代码: ```csharp public class BaseController : Controller { protected override void OnActionExecuting(ActionExecutingContext filterContext) { // 重OnActionExecuting以实现请求执行前的逻辑 base.OnActionExecuting(filterContext); } protected override void OnActionExecuted(ActionExecutedContext filterContext) { // 重OnActionExecuted以实现请求执行后的逻辑 base.OnActionExecuted(filterContext); } // 其他方法和属性定义... // 例如,一个简单的用户验证方法 protected bool AuthorizeUser() { // 进行用户验证的逻辑 return true; } } ``` 以上代码展示了一个简单的`BaseController`结构,实际应用中的`BaseController`可能会加复杂和功能丰富。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值