search

MakerHu / springboot-login-demo

Springboot后端登录注册项目演示demo
29 stars 9 forks source link

readme

springboot-login-demo

Springboot后端登录注册项目演示demo

前置条件

IDE： IDEA

数据库： MySQL

创建项目

注意：创建项目时保持网络通畅

  1. 打开IDEA

    IDEA图标

  2. 新建项目

    情况一：

    新建项目第一步

    情况二：

    新建项目第一步

    设置项目的基本信息，其中注意jdk版本要与Java版本匹配，这里使用jdk1.8和java8

新建项目第二步

选择SpringBoot版本，选择项目依赖（依赖可以创建完项目后在pom文件中修改）

新建项目第三步

新建项目第三步

至此项目就创建完成啦！

目录结构（初始状态）

项目目录结构

配置数据库

创建完项目后，如果直接运行项目，我们会发现项目报错了

报错图

报错的原因是我们在创建项目时导入了数据库相关的依赖，但是项目却还没有进行数据库相关配置

所以接下来我们先进行数据库的配置

创建数据库

要配置数据库，首先咱们得有个数据库，因此我们先用MySQL创建一个。由于本项目要演示登录注册功能的实现，所以在此我将创建一个用户表，保存用户的账号信息。

  1. 按Win+R打开“运行”，输入cmd

cmd

  1. 输入mysql -u root -p后输入密码，登录MySQL

    登录MySQL

  2. 创建数据库create database logindemologindemo为数据库名，根据你的情况修改

    创建数据库

  3. 进入数据库use logindemo

    进入数据库

  4. 创建user表

    CREATE TABLE user
(
   uid int(10) primary key NOT NULL AUTO_INCREMENT,
   uname varchar(30) NOT NULL,
   password varchar(255) NOT NULL,
   UNIQUE (uname)
);

    uid: 用户编号，主键，自增

    uname: 用户名，作为登录的账号（业务主键），不可重复

    password: 密码，因为可能要加密，所以长度设了较长的255

  5. 查看表是否创建成功

    desc user;

    查看user表信息

    到这数据库就创建完成啦，接下来就是在项目中配置数据库相关信息了。

配置数据库

  1. 找到配置文件application.properties

  2. 输入数据库相关配置信息（此处配置了项目端口号为8081，可不配置，默认端口号为8080）

    注意：配置url处logindemo改为你的数据库名称

    # 配置端口号为8081
server.port=8081

# 配置数据库
# 配置驱动
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 若连接的是云数据库则将localhost改为云端ip
spring.datasource.url=jdbc:mysql://localhost:3306/logindemo?serverTimezone=UTC
# Mysql用户
spring.datasource.username=root
# Mysql对应用户密码
spring.datasource.password=123456

    application.properties

    现在再次运行项目就能成功运行啦！

  3. 在IDEA中连接数据库（此步非必须，只是为了开发方便）

    在IDEA中连接数据库可以让我们在开发时直接可视化查看数据库的详细信息，建议配置一下。

    配置数据库基本信息

    注意：这一步有可能出现时区错误或者缺少依赖文件！！！

    解决方案

    时区错误：见图中配置时区

    缺少文件：根据提示点击下载，但由于服务器在外网，有可能需要科学上网

    完成以上配置后就能在IDEA中管理数据库啦！

项目架构图

在说项目的目录结构之前，我们先来聊一聊后端的架构大概是什么样的，方便我们对目录结构的理解。

项目架构图

注意：根据架构我们可以发现，最佳的开发方式是自底向上开发，因为包之间的调用是上层调用下层，所以下层现实现能保证实现多少测试多少

完善项目的基本目录结构

根据上述架构图的设计，我们就能创建对应的包让我们的项目框架更加清晰了。

  1. 创建各种包（以domain包为例）

    注意本项目中service与serviceImpl包为父子关系，也可以并列，这取决于你的喜好

    最终效果见下一步

    创建包

  2. 最终目录结构

    包含domain repository service serviceImpl controller utils config

    最终目录结构

    这时候眼尖的同学就发现了，怎么还多了俩： utils config

    这两个包的作用：

    • utils: 存放工具类，一些自己封装的工具
    • config: 存放配置类，一些配置如登录拦截器，安全配置等

    这里先建好了再说，具体怎么用之后会说。

登录注册功能实现

根据框架特点，我们将自底向上开发，所以将按照 实体类-dao-service-serviceImpl-controller 的顺序逐步开发。

实现User实体类

  1. 在domain中创建User.java

    创建User类

    创建User类

  2. 创建对应user表中字段的属性

    其中注意要添加@Table(name = "user")和@Entity注解

    • @Table(name = "user") 说明此实体类对应于数据库的user表
    • @Entity 说明此类是个实体类

    主键uid上要加上@Id与@GeneratedValue(strategy = GenerationType.IDENTITY)注解

    //domain中的User.java
package com.springboot.springbootlogindemo.domain;

import javax.persistence.*;

@Table(name = "user")
@Entity
public class User {
   // 注意属性名要与数据表中的字段名一致
   // 主键自增int(10)对应long
   @Id
   @GeneratedValue(strategy = GenerationType.IDENTITY)
   private long uid;

   // 用户名属性varchar对应String
   private String uname;

   // 密码属性varchar对应String
   private String password;

}

  3. 为属性生成get,set方法

    • 将光标移至要插入get, set方法的位置

    • 右键-generate-getter and setter

    • 选中所有属性-OK

    • 最后得到User.java（也可以纯手敲）

      package com.springboot.springbootlogindemo.domain;

import javax.persistence.*;

@Table(name = "user")
@Entity
public class User {
 // 注意属性名要与数据表中的字段名一致
 // 主键自增int(10)对应long
 @Id
 @GeneratedValue(strategy = GenerationType.IDENTITY)
 private long uid;

 // 用户名属性varchar对应String
 private String uname;

 // 密码属性varchar对应String
 private String password;

 public long getUid() {
     return uid;
 }

 public void setUid(long uid) {
     this.uid = uid;
 }

 public String getUname() {
     return uname;
 }

 public void setUname(String uname) {
     this.uname = uname;
 }

 public String getPassword() {
     return password;
 }

 public void setPassword(String password) {
     this.password = password;
 }
}

      至此User实体类就创建好啦，如果要实现其他表的实体类也类似。

实现UserDao

  1. 在repository包中创建UserDao接口

    创建UserDao

  2. 添加一些访问数据库的方法(这里添加的是根据用户名查询用户方法)

    • 首先要添加注解@Repository
    • 接口要继承JpaRepository，这样JPA就能帮助我们完成对数据库的映射，也就是说接口里写的方法只要符合格式可以不需要实现SQL语句就能直接用了。
    • 如果JPA没有提供你想要的方法，可以自定义SQL语句

    UserDao

    package com.springboot.springbootlogindemo.repository;

import com.springboot.springbootlogindemo.domain.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface UserDao extends JpaRepository<User, Long> {
   User findByUname(String uname); //通过用户名uname查找用户，注意要按照JPA的格式使用驼峰命名法
   User findByUnameAndPassword(String uname, String password);//通过用户名uname和密码查找用户
}

    由于我们只实现登录注册功能，所以只要有根据账号密码查询用户和插入用户信息的方法就行了，这里我们已经实现了根据用户名密码查找用户的方法，而插入用户信息的方法save(object o)JPA已经帮我们实现了，可以直接调用，这里就不需要写了。

    注意:这里接口方法的命名要按照JPA提供的命名格式,比如findBy, deleteBy等等,且要求驼峰命名法。如果自定义查询方法可以不遵守这个规则

    自定义查询方法例子(本项目不需要用到):

    @Query(value = "select * from user where uname LIKE ?1 OR email LIKE ?2 OR lastdid LIKE ?3 OR uid LIKE ?4",nativeQuery = true)
Page<User> findUserswithoutgender(
       String uname,
       String email,
       String lastdid,
       String uid,
       Pageable request
);

实现UserService

  1. 在service包中创建UserService接口

    创建UserService接口

    创建UserService接口

  2. 添加登录注册需要用到的业务逻辑方法

    • 最终UserService的完整代码
    package com.springboot.springbootlogindemo.service;

import com.springboot.springbootlogindemo.domain.User;

public interface UserService {
   /**
    * 登录业务逻辑
    * @param uname 账户名
    * @param password 密码
    * @return
    */
   User loginService(String uname, String password);

   /**
    * 注册业务逻辑
    * @param user 要注册的User对象，属性中主键uid要为空，若uid不为空可能会覆盖已存在的user
    * @return
    */
   User registService(User user);
}

  3. 完成了接口方法的定义，接下来是在UserServiceImpl中实现这些方法啦

实现UserServiceImpl

我们将在UserServiceImpl中实现UserService中的方法，完整的UserServiceImpl代码在此步骤的最后一小步里

  1. 在serviceImpl包中创建UserServiceImpl类

    创建UserServiceImpl类

    创建UserServiceImpl类

  2. 添加需要实现的方法

    • 添加implements UserService

      此时会报错，但没关系，只是因为方法还没实现。

    • 鼠标悬停在红色波浪线自动生成需要实现的方法（也可以手动一个个写）

      生成方法

      生成方法

    • 生成方法后的样子

      生成方法后的样子

  3. 实现登录业务逻辑

    • 因为要用到UserDao中的方法，所以先通过@Resource注解帮助我们实例化UserDao对象

    • 登录业务逻辑代码

      @Resource
private UserDao userDao;

@Override
public User loginService(String uname, String password) {
 // 如果账号密码都对则返回登录的用户对象，若有一个错误则返回null
 User user = userDao.findByUnameAndPassword(uname, password);
 // 重要信息置空
 if(user != null){
     user.setPassword("");
 }
 return user;
}

  4. 实现注册业务逻辑

    • 注册业务逻辑代码

      @Override
public User registService(User user) {
 //当新用户的用户名已存在时
 if(userDao.findByUname(user.getUname())!=null){
     // 无法注册
     return null;
 }else{
     //返回创建好的用户对象(带uid)
     User newUser = userDao.save(user);
     if(newUser != null){
         newUser.setPassword("");
     }
     return newUser;
 }
}

  5. 添加@Service注解

    添加@Service注解

  6. 最终UserServiceImpl完整代码

    package com.springboot.springbootlogindemo.service.serviceImpl;

import com.springboot.springbootlogindemo.domain.User;
import com.springboot.springbootlogindemo.repository.UserDao;
import com.springboot.springbootlogindemo.service.UserService;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;

@Service
public class UserServiceImpl implements UserService {
   @Resource
   private UserDao userDao;

   @Override
   public User loginService(String uname, String password) {
       // 如果账号密码都对则返回登录的用户对象，若有一个错误则返回null
       User user = userDao.findByUnameAndPassword(uname, password);
       // 重要信息置空
       if(user != null){
           user.setPassword("");
       }
       return user;
   }

   @Override
   public User registService(User user) {
       //当新用户的用户名已存在时
       if(userDao.findByUname(user.getUname())!=null){
           // 无法注册
           return null;
       }else{
           //返回创建好的用户对象(带uid)
           User newUser = userDao.save(user);
           if(newUser != null){
               newUser.setPassword("");
           }
           return newUser;
       }
   }
}

  7. 至此UserServiceImpl就写完啦！

实现工具类Result

工具类Result的作用是作为返回给前端的统一后的对象。也就是说返回给前端的都是Result对象，只是对象中的属性不太一样，这样方便前端固定接收格式。

  1. 在utils包中创建Result类

    创建Result类

    创建Result类

  2. 最终Result代码

    package com.springboot.springbootlogindemo.utils;

public class Result<T> {
   private String code;
   private String msg;
   private T data;

   public String getCode() {
       return code;
   }

   public void setCode(String code) {
       this.code = code;
   }

   public String getMsg() {
       return msg;
   }

   public void setMsg(String msg) {
       this.msg = msg;
   }

   public T getData() {
       return data;
   }

   public void setData(T data) {
       this.data = data;
   }

   public Result() {
   }

   public Result(T data) {
       this.data = data;
   }

   public static Result success() {
       Result result = new Result<>();
       result.setCode("0");
       result.setMsg("成功");
       return result;
   }

   public static <T> Result<T> success(T data) {
       Result<T> result = new Result<>(data);
       result.setCode("0");
       result.setMsg("成功");
       return result;
   }

   public static <T> Result<T> success(T data,String msg) {
       Result<T> result = new Result<>(data);
       result.setCode("0");
       result.setMsg(msg);
       return result;
   }

   public static Result error(String code, String msg) {
       Result result = new Result();
       result.setCode(code);
       result.setMsg(msg);
       return result;
   }
}

    可以看出Result是个模板类，因此想要返回什么数据类型给前端都行，如Result<User>，要是没看懂没关系，看到下面就知道怎么用了。因为里面有很多静态方法，可以直接用类名.方法名调用。

实现UserController

  1. 在controller包中创建UserController类

    创建UserController类

    创建UserController类

  2. 添加@RestController与@RequestMapping("/user")注解，注入UserService

    • 注解@RequestMapping中的"/user"是这个控制器类的基路由

  3. 实现登录的控制

    这里的@PostMapping("/login")表示处理post请求，路由为/user/login

    @PostMapping("/login")
public Result<User> loginController(@RequestParam String uname, @RequestParam String password){
   User user = userService.loginService(uname, password);
   if(user!=null){
       return Result.success(user,"登录成功！");
   }else{
       return Result.error("123","账号或密码错误！");
   }
}

  4. 实现注册的控制

    这里的@PostMapping("/register")表示处理post请求，路由为/user/register

    @PostMapping("/register")
public Result<User> registController(@RequestBody User newUser){
   User user = userService.registService(newUser);
   if(user!=null){
       return Result.success(user,"注册成功！");
   }else{
       return Result.error("456","用户名已存在！");
   }
}

  5. 完整的UserController代码

    package com.springboot.springbootlogindemo.controller;

import com.springboot.springbootlogindemo.domain.User;
import com.springboot.springbootlogindemo.service.UserService;
import com.springboot.springbootlogindemo.utils.Result;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;

@RestController
@RequestMapping("/user")
public class UserController {
   @Resource
   private UserService userService;

   @PostMapping("/login")
   public Result<User> loginController(@RequestParam String uname, @RequestParam String password){
       User user = userService.loginService(uname, password);
       if(user!=null){
           return Result.success(user,"登录成功！");
       }else{
           return Result.error("123","账号或密码错误！");
       }
   }

   @PostMapping("/register")
   public Result<User> registController(@RequestBody User newUser){
       User user = userService.registService(newUser);
       if(user!=null){
           return Result.success(user,"注册成功！");
       }else{
           return Result.error("456","用户名已存在！");
       }
   }
}

    至此所有的代码就都写完啦！！！

    接下来就是运行测试一下是否成功就行了。

Postman测试

  1. 打开postman

    postman

  2. 测试注册用户

    测试注册

    输入选则请求方式Post，输入路由http://localhost:8081/user/register，输入用户json对象后点击Send

    {
   "uname": "hhh",
   "password": "123"
}

    成功收到后端返回消息

    注册成功消息

  3. 登录测试

    登录测试

    类似于注册测试

    • 请求方式：POST
    • url：http://localhost:8081/user/login
    • 参数：见图中4，5步

    至此整个项目都写完并测试完啦！感谢你能耐心看到这，希望本教程对你有所帮助。