Springboot系列 3 - 建立简单的用户登录系统

在开始编码前，先建立几个Package(可以按个人习惯命名)，如图

1.Controllers 用于存放控制器类

2.Models 用于存放数据实体类

3.Repositories 用于存放数据库操作接口

4. Services 用于存放业务逻辑类

5. Tools用于存放工具类

-----------------------------------------------------------------------------------------------------------------------------

一、建立User实体类

首先在Models下新建名为User.java的实体类，

代码如下

@Entity //实体注入
@Table(name = "sys_user") //映射对应表明
public class User {
    @Id //主键Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String userName;
    private String hashedPassword;

    //省略getter和setter

    //重写toString方法便于后期调试查看数据
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", userName='" + userName + '\'' +
                ", hashedPassword='" + hashedPassword + '\'' +
                '}';
    }
}

二、新建CrudRepostory接口

在Repositories下新建一个名为UserRepository的接口，需要继承CrudRepository

CrudRepository是包含基础增删改查操作的Repository

public interface UserRepository extends CrudRepository<User,Long> {
}

其中不需要添加任何自定义方法就可以实现基础的数据库操作

三、新建用户登录操作业务类

在Services下新建UserService.java

@Service
public class UserService {
    //Autowire装配UserRepository数据库操作类
    @Autowired
    UserRepository userRepository;

    /**
     * 基础登录逻辑
     * @param userName 用户名
     * @param password MD5 hashed密码
     * @return
     */
    public boolean login(String userName,String password){
        Iterable<User> users = userRepository.findAll();
        for (User u:
             users) {
            if(u.getUserName().equals(userName) && u.getHashedPassword().equals(password)){
                return true;
            }
        }
        return false;
    }
}

很简单一个操作类，就不多作说明了

@Service注解表示这是一个Service类

四、建立Controller

在Controllers下建立UserController.java

@RestController
@RequestMapping(value = "/api/account")
public class UserController {
    @Autowired
    UserService userService;
    @RequestMapping(value = "/login/{username}/{password}",method = RequestMethod.GET)
    public boolean login(@PathVariable("username") String userName,@PathVariable("password") String password){
        return userService.login(userName,password);
    }
}

@RequestMapping 路由地址

@RestController 注解表示这是一个RESTController

@PathVariable 表示这是一个路由变量

-------------------------------------------------------------------------------------------------------------------------------------------

没什么问题保存后，就可以调试运行了

运行成功后，打开PostMan 通过Get方法访问我们的 http://localhost:8080/api/account/login/admin/admin

发送请求，由于我们数据库中没有任何数据，返回false

 

下边我们改造一下我们的登录结构，并为数据库添加一下基础数据

首先在UserRepository.java添加一个getByUserName方法

public interface UserRepository extends CrudRepository<User,Long> {
    //根据用户名查找用户
    Optional<User> getByUserName(String userName);
}

为了返回指定格式数据，我们还要在Models下建立一个Result.java

 

public class Result<T> {
    private Integer errCode;
    private String errMessage;
    private T data;

    //省略getter和setter
    @Override
    public String toString() {
        return "Result{" +
                "errCode=" + errCode +
                ", errMessage='" + errMessage + '\'' +
                ", data=" + data +
                '}';
    }
}

修改UserService.java，修改登录逻辑，增加添加初始数据

@Service
public class UserService {
    //Autowire装配UserRepository数据库操作类
    @Autowired
    UserRepository userRepository;

    /**
     * 基础登录逻辑
     * @param userName 用户名
     * @param password MD5 hashed密码
     * @return
     */
    public Result<Long> login(String userName, String password){
        Result<Long> result = new Result<>();
        User u = userRepository.getByUserName(userName).get();
        if(u == null){
            result.setErrCode(-1);
            result.setErrMessage("用户不存在");
        }else if(u.getHashedPassword().equals(password)){
            System.out.println(u.toString());
            result.setErrCode(0);
            result.setData(u.getId());
        }else {
            result.setErrCode(1);
            result.setErrMessage("密码错误");
        }
        return result;
    }

    public Result<User> add(User user){
        Result<User> result = new Result<>();
        User u = userRepository.save(user);
        if(u != null){
            result.setErrCode(0);
            result.setData(u);
        }else {
            result.setErrCode(-1);
            result.setErrMessage("发生错误");
        }
        return result;
    }

    public void initUserData(){
        Iterable<User> users = userRepository.findAll();
        int sum = 0;
        while (users.iterator().hasNext()){
            users.iterator().next();
            sum++;
        }
        if(sum == 0){
            for (int i = 0; i < 5; i++){
                User user = new User();
                user.setUserName("Admin" + i);
                String hashedPassword = Encrypt.stringMD5("Admin" + i);
                user.setHashedPassword(hashedPassword);
                add(user);
            }
        }

    }

其中用到的MD5加密类在Tools路径中,代码如下

import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

public class Encrypt {
    public static String stringMD5(String input) {

        try {
            // 拿到一个MD5转换器（如果想要SHA1参数换成”SHA1”）
            MessageDigest messageDigest =MessageDigest.getInstance("MD5");
            // 输入的字符串转换成字节数组
            byte[] inputByteArray = input.getBytes();
            // inputByteArray是输入字符串转换得到的字节数组
            messageDigest.update(inputByteArray);
            // 转换并返回结果，也是字节数组，包含16个元素
            byte[] resultByteArray = messageDigest.digest();
            // 字符数组转换成字符串返回
            return byteArrayToHex(resultByteArray);
        } catch (NoSuchAlgorithmException e) {
            return null;
        }
    }
    public static String byteArrayToHex(byte[] byteArray) {
        // 首先初始化一个字符数组，用来存放每个16进制字符
        char[] hexDigits = {'0','1','2','3','4','5','6','7','8','9', 'A','B','C','D','E','F' };
        // new一个字符数组，这个就是用来组成结果字符串的（解释一下：一个byte是八位二进制，也就是2位十六进制字符（2的8次方等于16的2次方））
        char[] resultCharArray =new char[byteArray.length * 2];
        // 遍历字节数组，通过位运算（位运算效率高），转换成字符放到字符数组中去
        int index = 0;
        for (byte b : byteArray) {
            resultCharArray[index++] = hexDigits[b>>> 4 & 0xf];
            resultCharArray[index++] = hexDigits[b& 0xf];
        }
        // 字符数组组合成字符串返回
        return new String(resultCharArray);
    }
}

在UserController中增加一个初始化数据路由方法

@RequestMapping(value = "/",method = RequestMethod.GET)
    public void initData(){
        userService.initUserData();
    }

调试运行项目

PostMan先请求 http://localhost:8080/api/account/

查看数据库，发现初始数据已经添加进来了

我们继续测试一下Login方法吧

(1)请求正确数据  http://localhost:8080/api/account/login/Admin1/2E33A9B0B06AA0A01EDE70995674EE23

返回 

{
"errCode": 0,
"errMessage": null,
"data": 2
}

返回正确

(2)请求错误数据 http://localhost:8080/api/account/login/Admin1/2E33A9B0B06A

返回

{
"errCode": 1,
"errMessage": "密码错误",
"data": null
}

返回密码错误，也符合我们的结果

(3)请求不存在用户数据 http://localhost:8080/api/account/login/blogn/2E33A9B0B06AA0A01EDE70995674

返回

{
"timestamp": "2018-07-17T13:52:24.082+0000",
"status": 500,
"error": "Internal Server Error",
"message": "No value present",
"path": "/api/account/login/blogn/2E33A9B0B06AA0A01EDE70995674"
}

系统自动返回500状态码，不符合预期，但也可以作参考，影响不大

 

我们简单的用户登录系统及这样了，其实我们还可以加入用户注册方法，大家可以自行尝试，我这里就不下了

以后的代码可能没这么详细了，只对重点代码做解释

希望给大家做一个参考