后端系统开发之——创建注册接口

原文地址：后端系统开发之——创建注册接口 - Pleasure的博客

下面是正文内容：

前言

这是一篇SpringBoot项目的实践篇。

主要用于介绍如何从零开始搭建某一种类型的系统。

个人认为，只要后端逻辑完善了，纵使前端页面千变万化都可以慢慢来，符合自己的审美就行。

当然我也才刚起步，不可能全部都是自己手搓（肯定会有所借鉴）。

正文

大致思路

接口的实现，一般要包括下面的几种功能：

注册，登录，获取用户详细信息，更新用户基本信息，更新用户头像，更新用户密码。

需要了解数据表中用户表的表结构（在此基础上进行搭建）

大致具体的流程：明确功能需求，阅读接口文档（明确输入输出），思路分析，开发写代码，调试正确性

接口文档，通常包括：基本信息（请求路径，请求方式，接口描述），请求参数（请求参数格式，请求参数说明），响应数据（响应数据类型，响应数据说明）

前置知识

先介绍一下前置知识——MVC（Model-View-Controller）架构。

必须掌握，不然你都不知道各个文件的作用以及对于整个项目的影响。

MVC通常用于构建用户界面和应用程序的组织结构，将应用程序分成三个核心组建：模型层（Model）、视图层（View）和控制层（Controller），每个部分都有不同的职责和功能。

以Web应用程序为例来进行解释。

控制层通常用于处理业务逻辑传递给视图层用于渲染页面，通常属于后端。

前端页面就属于视图层，负责展示模型层中的数据给用户，接收用户的操作。

模型层通常分为下面的几个类：

• 实体类（Entity），应用程序中的基本数据对象，通常与数据库中的表与文档相对应，包含了数据的结构和属性，决定了数据结构和关系，提供了数据的访问方式。
• 数据访问对象（DAO），用于与数据库进行交互的接口或类，负责执行数据库的CRUD（创建、读取、更新、删除）操作，并将数据库中的数据映射到实体类中。
• 业务逻辑（Business Logic），是应用程序中处理业务规则和流程的部分，用于执行特定的业务操作，并确保数据的完整性和一致性。（核心部分）
• 数据传输对象（DTO），用于在不同层之间传递数据的对象，它通常包含了一组数据属性和相应的访问方法。通常用于将实体类中的数据传递给视图层或控制层。

控制层通过将用户的请求转换成对模型层方法（接口）的调用来执行特定的业务操作，然后根据模型层返回的结果来决定如何响应用户的请求，并将模型处理的结果返回给视图层或者直接给用户。

控制器层和模型层的分离使得业务逻辑与用户界面的交互得以解耦，使得应用程序的不同部分可以独立开发、测试和维护。控制器层负责协调用户请求和业务逻辑的处理，而模型层负责处理具体的业务逻辑，从而实现了逻辑层和表示层的分离。

私有字段、公共getter和setter

私有字段是指类中的成员变量（属性），其访问权限仅限于类内部。。公共Getter和Setter是用于读取和修改对象的私有字段的公共方法。Getter用于获取私有字段的值，而Setter用于设置私有字段的值。主要用于封装对象的状态并提供对其访问和修改的方法。

顺便插一句：添加lombok依赖的作用，自动为实体类生成不同类型的构造函数，从而简化了Java代码编写时构造函数的麻烦。

主要组成部分

下面结合上面介绍的MVC典型架构，来解释一下SpringBoot项目中不同文件夹各自的作用。

• controller文件夹——控制层，在使用中通常用于接收用户的HTTP请求并返回HTTP响应，需要调用相应的业务逻辑。
• mapper文件夹——通常负责与数据库进行交互
• pojo文件夹——通常包含表示简单Java对象的Java类，具有私有字段、公共getter和setter，以及可能的构造函数。这些类通常用于在应用程序中建模数据，并且通常用作实体类或数据传输对象。
• service文件夹——模型层，包含具体服务的接口。
• service文件夹下的impl——用于上层文件夹接口的具体实现。
• utils文件夹——通常存放着一些工具类，是一些通用的、不属于业务逻辑的功能模块。用来执行一些常见的操作，比如字符串处理、日期操作、文件操作等。

user数据表——对应的字段以及属性

用户密码一般需要经过加密，数据库中记录MD5值

用户头像一般储存在第三方服务器上，数据库中记录索引值

部分代码

如果不是想具体上手实践的这一部分可以直接跳过了。结合上面提供的项目文件结构直接进行复制粘贴使用即可。

需要在pom.xml中添加lombok的依赖。

    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
    </dependency>

controller文件夹下的UserController.java的内容

package org.example.controller;

import org.example.pojo.Result;
import org.example.pojo.User;
import org.example.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @PostMapping("register")
    public Result register(String username,String password){
        //查询用户
            User u = userService.findByUserName(username);
            if (u==null){
                //没有占用
                //注册
                userService.register(username,password);
                return Result.success();
            }else{
                //占用
                return Result.error("用户名已被占用");
            }
        //注册
    }
}

mapper文件夹下的UserMapper.java的内容

package org.example.mapper;

import org.example.pojo.User;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
@Mapper
public interface UserMapper {
    //根据用户名查询用户
    @Select("select * from user where username=#{username}")
    User findByUserName(String username);

    //添加
    @Insert("insert into user(username,password,create_time,update_time)" +
            " values(#{username},#{password},now(),now())")
    void add(String username, String password);
}

pojo文件夹下的User.java的内容

package org.example.pojo;

import lombok.Data;

import java.time.LocalDateTime;
//lombok 在编译阶段，为实体类自动生成setter getter toString
//pom 文件中引入依赖 在实体类上添加注释

@Data
public class User {
    private Integer id;//主键ID
    private String username;//用户名
    private String password;//密码
    private String nickname;//昵称
    private String email;//邮箱
    private String userPic;//用户头像地址
    private LocalDateTime createTime;//创建时间
    private LocalDateTime updateTime;//更新时间
}

Article.java的内容

package org.example.pojo;

import lombok.Data;

import java.time.LocalDateTime;

@Data
public class Article {
    private Integer id;//主键ID
    private String title;//文章标题
    private String content;//文章内容
    private String coverImg;//封面图像
    private String state;//发布状态 已发布|草稿
    private Integer categoryId;//文章分类id
    private Integer createUser;//创建人ID
    private LocalDateTime createTime;//创建时间
    private LocalDateTime updateTime;//更新时间
}

Category.java的内容

package org.example.pojo;

import lombok.Data;

import java.time.LocalDateTime;

@Data
public class Category {
    private Integer id;//主键ID
    private String categoryName;//分类名称
    private String categoryAlias;//分类别名
    private Integer createUser;//创建人ID
    private LocalDateTime createTime;//创建时间
    private LocalDateTime updateTime;//更新时间
}

Result.java的内容

package org.example.pojo;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

//统一响应结果
@NoArgsConstructor
@AllArgsConstructor
@Data
public class Result<T> {
    private Integer code;//业务状态码  0-成功  1-失败
    private String message;//提示信息
    private T data;//响应数据

    //快速返回操作成功响应结果(带响应数据)
    public static <E> Result<E> success(E data) {

        return new Result<>(0, "操作成功", data);
    }

    //快速返回操作成功响应结果
    public static Result success() {

        return new Result(0, "操作成功", null);
    }

    public static Result error(String message) {

        return new Result(1, message, null);
    }
}

Service文件夹下Userservice.java的内容

package org.example.service;

import org.example.pojo.User;
public interface UserService {
    //根据用户名查询用户
    User findByUserName(String username);
    //注册
    void register(String username,String password);
}

UserServiceImpl的内容

package org.example.service.impl;

import org.example.mapper.UserMapper;
import org.example.pojo.User;
import org.example.service.UserService;
import org.example.utils.Md5Util;
import org.example.utils.ThreadLocalUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.time.LocalDateTime;
import java.util.Map;

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;
    @Override
    public User findByUserName(String username) {
        User u = userMapper.findByUserName(username);
        return u;
    }

    @Override
    public void register(String username, String password) {
        //MD5加密密码
        String md5String = Md5Util.getMD5String(password);
        //添加
        userMapper.add(username,md5String);
    }

    @Override
    public void update(User user){
        user.setUpdateTime(LocalDateTime.now());
        userMapper.update(user);
    }

    @Override
    public void updateAvatar(String avatarUrl){
        Map<String,Object> map = ThreadLocalUtil.get();
        Integer id = (Integer) map.get("id");
        userMapper.updateAvatar(avatarUrl,id);
    }

    @Override
    public void updatePwd(String newPwd){
        Map<String,Object> map = ThreadLocalUtil.get();
        Integer id = (Integer) map.get("id");
        userMapper.updatePwd(Md5Util.getMD5String(newPwd),id);
    }
}

utils文件夹下Md5Util.java的内容

package org.example.service;

import org.example.pojo.User;
public interface UserService {
    //根据用户名查询用户
    User findByUserName(String username);
    //注册
    void register(String username,String password);
}

SystemApplication.java的内容

package org.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SystemApplication {
    public static void main( String[] args ) {
        SpringApplication.run(SystemApplication.class,args);
    }
}

application.yml的内容

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/数据表名
    username: root
    password: root

接口成功验证

因为缺少前端页面，所以需要用到接口检验工具。

这里推荐的软件是Apifox，功能强大且目前使用范围较广。

首先重启一下项目程序

按照下图的方式传递参数，可以看到返回的json格式符合一般接口文档的要求。

可以看到Windows本地MySQL数据库成功接收到新插入的username，password数据。

接口开发成功。

尾声

后面会针对系统需要的功能针对性的一个接口一个接口进行开发，大家点个关注跟进一下。