Springboot项目搭建（9）-分页与文件上传

发布于：2025-03-24 ⋅ 阅读:(25) ⋅ 点赞:(0)

1.添加依赖

在pom.xml中添加分页依赖

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.4.6</version>
</dependency>

2.Entity层

定义实体类，用于表示数据模型。

定义文章类

表示新闻文章的实体，同时也是进行分页的目标。

package org.news.entity;

import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Pattern;
import org.hibernate.validator.constraints.URL;
import org.news.anno.State;

import java.time.LocalDateTime;

public class Article {
    private Integer id; // 主键
    @NotEmpty
    @Pattern(regexp = "^\\S{1,10}$")
    private String title; // 标题
    @NotEmpty
    private String content; // 内容
    @NotEmpty
    @URL
    private String coverImg; // 封面
    @State
    private String state; // 状态
    @NotNull
    private Integer categoryId; // 分类ID
    private Integer createUser; // 创建者ID
    private LocalDateTime createTime; // 创建时间
    private LocalDateTime updateTime; // 修改时间
    // Getter 和 Setter 方法
}

3.定义分页工具类

用于封装分页的数据【org/news/entity/PageBean.java】

PageBean<T>：是一个泛型类，其中<T>可以处理任何类型的对象。

也就是说，它可以封装不同类型的对象，例如用户信息、新闻文章、商品列表等。

private Long total：表示总记录数。即总共有多少新闻、多少用户记录等

import java.util.List;
public class PageBean<T> {
    private Long total; // 总记录数
    private List<T> items; // 当前页的数据

    // Getter 和 Setter 方法
}

4.定义响应结果类

 定义一个Result类，用于封装API的返回结果

package org.news.entity;

public class Result<T> {
    private boolean success; // 是否成功
    private String message; // 错误信息
    private T data; // 返回的数据

    public static <T> Result<T> success(T data) {
        Result<T> result = new Result<>();
        result.success = true;
        result.data = data;
        return result;
    }

    public static <T> Result<T> error(String message) {
        Result<T> result = new Result<>();
        result.success = false;
        result.message = message;
        return result;
    }

    // Getter 和 Setter 方法
}

5.定义自定义注解

定义自定义注解 State，以及自定义注解的验证器StateValidator，用于验证文章状态。

//State
import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.*;
@Documented
@Constraint(validatedBy = StateValidator.class)
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface State {
    String message() default "Invalid state value";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

//StateValidator
import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;
public class StateValidator implements ConstraintValidator<State, String> {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return value != null && (value.equals("已发布") || value.equals("未发布"));
    }
}

6.Mapper层

负责与数据库交互，执行具体的 SQL 操作。

定义Mapper XML文件

定义 ArticleMapper 的 XML 文件，用于实现分页查询。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.news.mapper.ArticleMapper">
    <select id="list" resultType="org.news.entity.Article">
        select * from article
        <where>
            <if test="categoryId != null">
                and category_id = #{categoryId}
            </if>
            <if test="state != null">
                and state = #{state}
            </if>
            and create_user = #{userId}
        </where>
    </select>
</mapper>

自定义mapper

 定义 ArticleMapper 接口，用于定义数据库操作。

package org.news.mapper;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.news.entity.Article;
import java.util.List;
@Mapper
public interface ArticleMapper {
    @Insert("insert into article(title, content, state, category_id, create_user, create_time, update_time) " +
            "values (#{title}, #{content}, #{state}, #{categoryId}, #{createUser}, #{createTime}, #{updateTime})")
    void insertArticle(Article article);

    List<Article> list(@Param("userId") Integer userId, @Param("categoryId") Integer categoryId, @Param("state") String state);
}

7.Service层

负责处理业务逻辑，调用 Mapper 层的方法来完成数据的持久化操作。

定义 Service 接口 

定义 ArticleService 接口，用于声明业务逻辑操作。

package org.news.service;
import org.news.entity.Article;
import org.news.entity.PageBean;
public interface ArticleService {
    void insertArticle(Article article);
    PageBean<Article> list(Integer pageNum, Integer pageSize, Integer categoryId, String state);
}

实现 Service 接口 

实现 ArticleService 接口，提供具体的业务逻辑。

package org.news.service.impl;

import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import org.news.entity.Article;
import org.news.entity.PageBean;
import org.news.mapper.ArticleMapper;
import org.news.service.ArticleService;
import org.news.utils.ThreadLocalUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.time.LocalDateTime;
import java.util.List;
import java.util.Map;
@Service
public class ArticleServiceImpl implements ArticleService {
    @Autowired
    private ArticleMapper articleMapper;
    @Override
    public void insertArticle(Article article) {
        article.setCreateTime(LocalDateTime.now());
        article.setUpdateTime(LocalDateTime.now());
        Map<String, Object> map = ThreadLocalUtil.get();
        Integer id = (Integer) map.get("id");
        article.setCreateUser(id);
        articleMapper.insertArticle(article);
    }
    @Override
    public PageBean<Article> list(Integer pageNum, Integer pageSize, Integer categoryId, String state) {
        PageBean<Article> pb = new PageBean<>();
        PageHelper.startPage(pageNum, pageSize);
        Map<String, Object> map = ThreadLocalUtil.get();
        Integer id = (Integer) map.get("id");
        List<Article> articleList = articleMapper.list(id, categoryId, state);
        Page<Article> page = (Page<Article>) articleList;
        pb.setTotal(page.getTotal());
        pb.setItems(page.getResult());
        return pb;
    }
}

8.Controller 层

负责接收和处理客户端的请求，调用 Service 层的方法来完成业务逻辑，并将结果返回给客户端。

定义 Controller 

定义 ArticleController，提供 RESTful API 接口。

package org.news.controller;
import org.news.entity.Article;
import org.news.entity.PageBean;
import org.news.entity.Result;
import org.news.service.ArticleService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/article")
public class ArticleController {
    @Autowired
    private ArticleService articleService;

    @PostMapping("add")
    public Result add(@RequestBody @Validated Article article) {
        articleService.insertArticle(article);
        return Result.success();
    }
    @GetMapping("list")
    public Result<PageBean<Article>> list(Integer pageNum, Integer pageSize, @RequestParam(required = false) Integer categoryId, @RequestParam(required = false) String state) {
        PageBean<Article> pageBean = articleService.list(pageNum, pageSize, categoryId, state);
        return Result.success(pageBean);
    }
}

9.小结 

大致的编码步骤与思路：

  1. 定义实体类（Entity）：根据业务需求定义数据模型，包括属性和验证注解。
  2. 定义分页工具类（PageBean）：用于封装分页数据，包括总记录数和当前页的数据。
  3. 定义响应结果类（Result）：用于封装 API 的返回结果，包括是否成功、错误信息和返回的数据。
  4. 定义自定义注解（State）：用于验证文章状态，确保状态值只能是“已发布”或“未发布”。
  5. 定义 Mapper 接口和 XML 文件：使用 MyBatis 定义数据库操作接口和对应的 SQL 映射文件。
  6. 定义 Service 接口及其实现：声明业务逻辑操作，并在实现类中调用 Mapper 层的方法。
  7. 定义 Controller：提供 RESTful API 接口，调用 Service 层的方法来完成具体的业务逻辑。
  8. 补充功能和细节：包括异常处理、日志记录、安全性等，以确保系统的健壮性和安全性。

N.文件上传

package org.news.controller;

import org.news.entity.Result;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import java.io.File;
import java.util.UUID;

@RestController
public class FileUploadController {
    @PostMapping("upload")
    public Result<String> upload(MultipartFile file)throws Exception {
        //获取上传文件的名称
        String originalFilename = file.getOriginalFilename();
        //设置文件名唯一
        String filename = UUID.randomUUID().toString()+originalFilename.substring(originalFilename.lastIndexOf("."));
        file.transferTo(new File("D:\\workspace\\"+filename));
        return Result.success("url访问地址");
    }
}

网站公告

今日签到

点亮在社区的每一天
去签到

热门文章

最新发布