Springboot初始化项目并完成登入注册的全过程

目录

idea spring Initializr创建项目勾选项目所需要的依赖整体项目结构创建User实体类放入Enity下创建通用返回的结果类创建controller创建service层创建Mapper / Dao层邮箱验证码、生成Token总结

idea spring Initializr创建项目

勾选项目所需要的依赖

pom.xml文件会加载勾选的依赖，也可以不勾选后面通过自己常用的pom.xml统一导入。

Lombok 可以通过注解省去一些get，set方法。

简单项目常用pom.xml：
mybatis-plus、mybatis、

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
4.     <modelVersion>4.0.0</modelVersion>
5.     <parent>
6.         <groupId>org.springframework.boot</groupId>
7.         <artifactId>spring-boot-starter-parent</artifactId>
8.         <version>2.7.3</version>
9.         <relativePath/> <!-- lookup parent from repository -->
10.     </parent>
11.     <groupId>com.example.community</groupId>
12.     <artifactId>springboot03</artifactId>
13.     <version>0.0.1-SNAPSHOT</version>
14.     <name>springboot03</name>
15.     <description>springboot03</description>
16.     <properties>
17.         <java.version>1.8</java.version>
18.     </properties>
19.     <dependencies>
20.         <dependency>
21.             <groupId>org.springframework.boot</groupId>
22.             <artifactId>spring-boot-starter-web</artifactId>
23.         </dependency>
24.         <dependency>
25.             <groupId>org.mybatis.spring.boot</groupId>
26.             <artifactId>mybatis-spring-boot-starter</artifactId>
27.             <version>2.2.2</version>
28.         </dependency>
30.         <dependency>
31.             <groupId>mysql</groupId>
32.             <artifactId>mysql-connector-java</artifactId>
33.             <scope>runtime</scope>
34.         </dependency>
35.         <dependency>
36.             <groupId>org.springframework.boot</groupId>
37.             <artifactId>spring-boot-starter-test</artifactId>
38.             <scope>test</scope>
39.         </dependency>
40.         <dependency>
41.             <groupId>org.projectlombok</groupId>
42.             <artifactId>lombok</artifactId>
43.         </dependency>
44.         <dependency>
45.             <groupId>com.baomidou</groupId>
46.             <artifactId>mybatis-plus-boot-starter</artifactId>
47.             <version>3.4.2</version>
48.         </dependency>
49.         <dependency>
50.             <groupId>com.alibaba</groupId>
51.             <artifactId>druid</artifactId>
52.             <version>1.1.13</version>
53.         </dependency>
55.         <dependency>
56.             <groupId>io.jsonwebtoken</groupId>
57.             <artifactId>jjwt</artifactId>
58.             <version>0.9.1</version>
59.         </dependency>
60.         <dependency>
61.             <groupId>org.codehaus.jackson</groupId>
62.             <artifactId>jackson-mapper-asl</artifactId>
63.             <version>1.9.13</version>
64.         </dependency>
65.         <dependency>
66.             <groupId>org.springframework.boot</groupId>
67.             <artifactId>spring-boot-starter-mail</artifactId>
68.         </dependency>
69.         <dependency>
70.             <groupId>org.springframework.boot</groupId>
71.             <artifactId>spring-boot-configuration-processor</artifactId>
72.             <optional>true</optional>
73.         </dependency>
75.     </dependencies>
77.     <build>
78.         <plugins>
79.             <plugin>
80.                 <groupId>org.springframework.boot</groupId>
81.                 <artifactId>spring-boot-maven-plugin</artifactId>
82.             </plugin>
83.         </plugins>
84.     </build>
86. </project>

复制代码

整体项目结构

创建User实体类放入Enity下

@TableName("user")是实体对应的表的名字
@TableId(type = IdType.AUTO)表的主键
@TableField(exist = false)不存在，就不会返回空。

1. package com.example.community.enity;
3. import com.baomidou.mybatisplus.annotation.IdType;
4. import com.baomidou.mybatisplus.annotation.TableField;
5. import com.baomidou.mybatisplus.annotation.TableId;
6. import com.baomidou.mybatisplus.annotation.TableName;
7. import lombok.Data;
9. @Data
10. @TableName("user")
11. public class User {
12.     @TableId(type = IdType.AUTO)
13.     private Integer userId;
14.     private String email;
15.     private String username;
16.     private String password;
17.     private String avatar;
18.     private String phone;
19.     @TableField(exist = false)
20.     private String code;
21.     public User(String email, String password) {
22.         this.email = email;
23.         this.password = password;
24.     }
25. }

复制代码

创建通用返回的结果类

可以使用泛型传入对应的实体类，这里我就不传了。

1. package com.example.community.common;
3. import lombok.Data;
5. @Data
6. public class R {
7.     private Integer code;
8.     private String msg;
9.     private Object data;
11.     public R(Integer code, String msg, Object ob) {
12.         this.code = code;
13.         this.msg = msg;
14.         this.data = ob;
15.     }
16.     public R(Integer code, String msg) {
17.         this.code = code;
18.         this.msg = msg;
19.     }
20.     public static  R success(String msg){
21.         R r= new R(1,msg);
22.         return r;
23.     }
24.     public static  R success(String msg,Object ob){
25.         R r= new R(1,msg,ob);
26.         return r;
27.     }
29.     public static  R error(String msg){
30.         R r= new R(0,msg,null);
31.         return r;
32.     }
33. }

复制代码

创建controller

在controller里可以对前端的请求进行一个分发，处理。根据地址链接找到对应的controller。
登入模块，可以创建一个UserController处理用户的相关信息。

1. package com.example.community.controller;
3. import com.example.community.common.R;
4. import com.example.community.enity.User;
5. import com.example.community.service.UserService;
6. import lombok.extern.slf4j.Slf4j;
7. import org.springframework.beans.factory.annotation.Autowired;
8. import org.springframework.web.bind.annotation.*;
10. import javax.servlet.http.HttpSession;
11. import java.util.Map;
13. @Slf4j
14. @RestController()
15. @RequestMapping("/user")
16. @CrossOrigin(origins = {"http://localhost:8090", "null"})
17. public class UserController {
18.     @Autowired
19.     UserService service;
21.     @PostMapping("/login")
22.     public R login(@RequestBody User user) {
23.         log.info("user"+user.toString());
24.         return service.login(user.getEmail(), user.getPassword());
25.     }
27.     @PostMapping("/register")
28.     @ResponseBody
29.     public R register(@RequestBody Map<String, Object> data, HttpSession session) {
30.         log.info(data.toString());
31.         String code1 = (String) session.getAttribute("code");
32.         String email1 = (String) session.getAttribute("email");
33.         log.info("---------------------------");
34.         log.info(email1);
35.         log.info(code1);
36.         log.info("---------------------------");
37.         if(code1 == null || email1 == null){
38.             return R.error("验证码已过期或邮箱有误");
39.         }
40.         if (!data.get("password").equals(data.get("password_confirmation"))) {
41.             return R.error("两次密码不一致");
42.         }
44.         if (!email1.equals(data.get("email").toString())) {
45.             return R.error("邮箱错误");
46.         }
47.         if (!code1.equals(data.get("code").toString())) {
48.             return R.error("验证码错误");
49.         }
50.         User user1 = new User(data.get("email").toString(), data.get("password").toString());
51.         return service.register(user1);
52.     }
53. }

复制代码

创建service层

service层给controller层提供服务，调用dao层mapper查询数据库的数据，提供相对应的服务。
在这里我是用了mybtis-plus来进行数据库简单的查询。
用户模块的service层代码：
UserService接口
继承mybatis-plus的IService

1. package com.example.community.service;
3. import com.baomidou.mybatisplus.extension.service.IService;
4. import com.example.community.common.R;
5. import com.example.community.enity.User;
7. public interface UserService extends IService<User> {
8.     public R selectUserByUsername(String name);
9.     public R login(String username, String password);
10.     public R register(User user);
11.     public R logout(String token);
12. }

复制代码

UserService实现类
在这个类中，调用了mapper提供的方法。
继承ServiceImpl

1. package com.example.community.service.impl;
3. import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
4. import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
5. import com.example.community.Mapper.UserMapper;
6. import com.example.community.common.R;
7. import com.example.community.enity.User;
8. import com.example.community.service.UserService;
9. import org.springframework.beans.factory.annotation.Autowired;
10. import org.springframework.stereotype.Service;
12. @Service
13. public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
14.     @Autowired
15.     private UserMapper userMapper;
16.     @Override
17.     public R selectUserByUsername(String name){
18.         return null;
19.     }
20.     @Override
21.     public R login(String email, String password){
22.         User user = userMapper.selectOne(new QueryWrapper<User>().eq("email", email));
23.         if(user == null){
24.             return R.error("用户不存在");
25.         }
26.         if(!user.getPassword().equals(password)){
27.             return R.error("密码错误");
28.         }
29.         return R.success("登录成功");
30.     }
31.     @Override
32.     public R register(User user){
33.         User user1 = userMapper.selectOne(new QueryWrapper<User>().eq("username", user.getUsername()));
34.         if(user1 != null){
35.             return R.error("用户已存在");
36.         }
37.         userMapper.insert(user);
38.         return R.success("注册成功");
39.     }
41.     @Override
42.     public R logout(String token){
43.         return null;
44.     }
45. }

复制代码

创建Mapper / Dao层

使用了mybatis-plus，所以只需要继承BaseMapper既可。

1. package com.example.community.Mapper;
3. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
4. import com.example.community.enity.User;
5. import org.apache.ibatis.annotations.Mapper;
7. @Mapper
8. public interface UserMapper extends BaseMapper<User> {
10. }

复制代码

邮箱验证码、生成Token

使用邮箱进行登入验证码验证使用jwt生成token返回给前端，服务端可以用来判断用户是否登入。并且支持跨域

实现这两个功能需要使用到一些工具类和配置，如下：

1. package com.example.community.utils;
3. import io.jsonwebtoken.Jwt;
4. import io.jsonwebtoken.JwtBuilder;
5. import io.jsonwebtoken.Jwts;
6. import io.jsonwebtoken.SignatureAlgorithm;
8. import java.util.Date;
9. import java.util.HashMap;
10. import java.util.Map;
12. public class JWTUtils {
14.     private static final String jwtToken = "123456Mszlu!@#$$";
16.     public static String createToken(Long userId) {
17.         Map<String, Object> claims = new HashMap<>();
18.         claims.put("userId", userId);
19.         JwtBuilder jwtBuilder = Jwts.builder()
20.                 .signWith(SignatureAlgorithm.HS256, jwtToken) // 签发算法，秘钥为jwtToken
21.                 .setClaims(claims) // body数据，要唯一，自行设置
22.                 .setIssuedAt(new Date()) // 设置签发时间
23.                 .setExpiration(new Date(System.currentTimeMillis() + 24 * 60 * 60 * 1000));// 一天的有效时间
24.         String token = jwtBuilder.compact();
25.         return token;
26.     }
28.     public static Map<String, Object> checkToken(String token) {
29.         try {
30.             Jwt parse = Jwts.parser().setSigningKey(jwtToken).parse(token);
31.             return (Map<String, Object>) parse.getBody();
32.         } catch (Exception e) {
33.             e.printStackTrace();
34.         }
35.         return null;
37.     }
38. }

复制代码

拦截器的配置

1. package com.example.community.handler;
3. import com.alibaba.druid.util.StringUtils;
4. import com.example.community.common.R;
5. import com.example.community.utils.JsonUtil;
6. import lombok.extern.slf4j.Slf4j;
7. import org.springframework.stereotype.Component;
8. import org.springframework.web.method.HandlerMethod;
9. import org.springframework.web.servlet.HandlerInterceptor;
11. import javax.servlet.http.HttpServletRequest;
12. import javax.servlet.http.HttpServletResponse;
14. @Component
15. @Slf4j
16. public class LoginInterceptor implements HandlerInterceptor {
18.     @Override
19.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response,Object handler) throws  Exception{
20.         log.info("请求被拦截{}",request);
22.         if(!(handler instanceof HandlerMethod)){
23.             return true;
24.         }
25.         String token = request.getHeader("Authorization");
26.         log.info("token:{}",token);
27.         if(StringUtils.isEmpty(token)){
28.             R r= R.error("未登录");
29.             response.setContentType("application/json;charset=utf-8");
30.             log.info("{}",r);
31.             response.getWriter().print(JsonUtil.objectToJson(r));
32.             return false;
33.         }
35.         return true;
36.     }
37. }

复制代码

1. package com.example.community.config;
3. import com.example.community.handler.LoginInterceptor;
4. import org.springframework.context.annotation.Configuration;
5. import org.springframework.web.servlet.config.annotation.CorsRegistry;
6. import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
7. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
9. @Configuration
10. public class WebMvcConfig implements WebMvcConfigurer {
11.     @Override
12.     public void addInterceptors(InterceptorRegistry registry) {
13.         // 用户拦截器
14.         registry.addInterceptor(new LoginInterceptor())
15.                 // 需要拦截的请求
16.                 .addPathPatterns("/user/**","/article/**")
17.                 // 需要放行的请求
18.                 .excludePathPatterns("/user/login","/user/register","/mail/**")
19.                 // 添加swagger-ui的放行路径
20.                 .excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**", "/doc.html/**")
21.         ;
22.     }
23.     @Override
24.     public void addCorsMappings(CorsRegistry registry) {
25.         registry.addMapping("/**")
26.                 .allowedOriginPatterns("*")
27.                 .allowedMethods("POST", "GET", "PUT", "OPTIONS", "DELETE")
28.                 .maxAge(3600)
29.                 .allowCredentials(true);
30.     }
31. }

复制代码

实现邮箱认证登入，之前写过一个，传送门

总结

到此这篇关于Springboot初始化项目并完成登入注册的文章就介绍到这了,更多相关Springboot初始化项目并登入注册内容请搜索中国红客联盟以前的文章或继续浏览下面的相关文章希望大家以后多多支持中国红客联盟！