WordPress 基础配置与 MyBatis-Plus 接口开发实践

需要下载 MyBatisX 插件。在数据库中点击表单生成 mybatisX-generator -> module path, basepackage，使用的是 domain -> annotation, MyBatis-Plus3, options comment, lombok。

如果在使用 MyBatisX 插件时没有看到 MyBatis-Plus3 的模板，建议升级插件版本。

环境配置建议

• IDEA 2019 版本建议使用 JDK 17 以下版本，建议尽量使用 2023 版本以上。
• 检查 Maven 文件位置：点击 File -> Settings -> 搜索 Maven，可以查看到自己 Maven 路径，没有则自己创建 Maven 的文件。

插件安装

对于使用 MyBatisX 的插件，安装步骤如下： File -> Settings -> Plugins -> 搜索 MyBatisX 安装 -> Download, Install, Apply -> 重启 IDEA。

数据库连接测试

点击 Database 的 + -> Data Source -> MySQL。刚开始的时候 MySQL 在下面，自己慢慢找。

Host 这里填写云数据库的地址（需自行配置服务器）。User, Password 填写自己的数据库密码。点击测试连接，Apply, OK。

测试成功都没问题，就是没看到数据库表在哪里，这个时候点击连接数据的右键，看到 Tools -> Manage Shown Schemas，自己在点击自己的想要的数据库。

好了，这些都出来，数据库使用右键出现 mybatisX-Generator。

Service 层说明

Service 接口文件定义业务逻辑的抽象方法，提供业务逻辑的契约，便于实现多态和松耦合。 ServiceImpl 实现类文件位于 service/impl 包下，实现 Service 接口的具体逻辑。

RESTful 接口设计与 MyBatis-Plus 实现

以下是一套完整的用户好友关系 RESTful 接口设计（含 Controller、Service、Mapper 实现），使用 Spring Boot + MyBatis-Plus 快速实现增删改查（CRUD）。

1. 接口清单（API Design）

2. Controller 层实现

@RestController
@RequestMapping("/friends")
@RequiredArgsConstructor
public class FriendController {
    private final FriendService friendService;

    @PostMapping
    public Result<Boolean> addFriend(@RequestBody @Valid FriendRequest request) {
        return Result.success(friendService.addFriend(request.getUserId(), request.getFriendId()));
    }

    @DeleteMapping
    public Result<Boolean> deleteFriend(@RequestBody @Valid FriendRequest request) {
        return Result.success(friendService.deleteFriend(request.getUserId(), request.getFriendId()));
    }

    @GetMapping("/{userId}")
    public Result<List<FriendDTO>> getFriends(@PathVariable Integer userId) {
        return Result.success(friendService.getFriends(userId));
    }

    @GetMapping("/check")
    public Result<Boolean> isFriend(@RequestParam Integer userId, @RequestParam Integer friendId) {
        return Result.success(friendService.isFriend(userId, friendId));
    }

    // 参数封装类
    @Data
    static class FriendRequest {
        @NotNull
        private Integer userId;
        @NotNull
        private Integer friendId;
    }
}

3. Service 层实现

@Service
@RequiredArgsConstructor
public class FriendServiceImpl implements FriendService {
    private final UserMapper userMapper;
    private final FriendRelationMapper relationMapper;

    @Override
    @Transactional
    public boolean addFriend(Integer userId, Integer friendId) {
        // 1. 校验用户是否存在
        checkUserExists(userId);
        checkUserExists(friendId);
        // 2. 检查是否已是好友
        if (relationMapper.existsRelation(userId, friendId)) {
            return false;
        }
        // 3. 双向添加关系
        relationMapper.insert(new FriendRelation(userId, friendId));
        relationMapper.insert(new FriendRelation(friendId, userId));
        return true;
    }

    @Override
    @Transactional
    public boolean deleteFriend(Integer userId, Integer friendId) {
        relationMapper.deleteRelation(userId, friendId);
        relationMapper.deleteRelation(friendId, userId);
        return true;
    }

    @Override
    public List<FriendDTO> getFriends(Integer userId) {
        return relationMapper.selectFriendList(userId).stream()
                .map(user -> new FriendDTO(user.getId(), user.getNickname(), user.getAvatar()))
                .collect(Collectors.toList());
    }

    @Override
    public boolean isFriend(Integer userId, Integer friendId) {
        return relationMapper.existsRelation(userId, friendId);
    }

    private void checkUserExists(Integer userId) {
        if (userMapper.selectById(userId) == null) {
            throw new BusinessException("用户不存在");
        }
    }
}

4. Mapper 层（MyBatis-Plus）

(1) 好友关系实体

@Data
@TableName("user_friend_relation")
public class FriendRelation {
    @TableId(type = IdType.AUTO)
    private Long id;
    private Integer userId;
    private Integer friendId;
    private LocalDateTime createTime;
}

(2) Mapper 接口

public interface FriendRelationMapper extends BaseMapper<FriendRelation> {
    @Select("SELECT COUNT(1) FROM user_friend_relation " +
            "WHERE user_id = #{userId} AND friend_id = #{friendId}")
    boolean existsRelation(@Param("userId") Integer userId, @Param("friendId") Integer friendId);

    @Delete("DELETE FROM user_friend_relation " +
            "WHERE user_id = #{userId} AND friend_id = #{friendId}")
    int deleteRelation(@Param("userId") Integer userId, @Param("friendId") Integer friendId);

    @Select("SELECT u.* FROM user u " +
            "JOIN user_friend_relation r ON u.id = r.friend_id " +
            "WHERE r.user_id = #{userId}")
    List<User> selectFriendList(Integer userId);
}

5. 统一返回结构

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

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

6. 接口测试示例

(1) 添加好友

POST /friends
Content-Type: application/json
{
  "userId": 1,
  "friendId": 2
}

响应：

{"code":200,"msg":"success","data":true}

(2) 查询好友列表

GET /friends/1

响应：

{"code":200,"msg":"success","data":[{"id":2,"nickname":"张三","avatar":"https://xxx.jpg"}]}

关键设计说明

1. 事务控制：增删操作添加 @Transactional。
2. 参数校验：使用 @Valid + @NotNull 注解。
3. RESTful 规范：
   • 创建用 POST，删除用 DELETE。
   • 查询用 GET，参数区分路径参数和查询参数。
4. 性能优化：
   • 使用 JOIN 查询避免 N+1 问题。
   • 数据库添加联合索引 (user_id, friend_id)。

扩展建议

缓存优化：

@Cacheable(value = "user:friends", key = "#userId")
public List<FriendDTO> getFriends(Integer userId) {
    // ...
}

分页查询：

@GetMapping("/{userId}/page")
public PageResult<FriendDTO> getFriendsByPage(
        @PathVariable Integer userId,
        @RequestParam(defaultValue = "1") Integer page,
        @RequestParam(defaultValue = "10") Integer size) {
    Page<User> pagedUsers = relationMapper.selectFriendPage(new Page<>(page, size), userId);
    return PageResult.success(pagedUsers.convert(this::convertToDTO));
}

这套接口提供了标准的 CRUD 模板，可根据实际需求调整字段和逻辑。

数据库索引优化

为什么需要为数据库的 email 字段建立索引

为数据库中的 email 字段建立索引是数据库优化的重要实践，主要原因包括：

1. 提高查询性能

• 快速用户查找：当系统需要通过 email 查找用户时（如登录、密码重置等操作），索引可以将查询复杂度从 O(n) 降到 O(log n)。
• 加速 JOIN 操作：如果 email 作为外键关联其他表，索引能显著提升关联查询速度。

2. 保证数据唯一性（当需要时）

• 避免重复注册或数据不一致问题。
• 通过创建唯一索引 (UNIQUE INDEX)，可以确保：

CREATE UNIQUE INDEX idx_email ON users(email);

3. 支持高级查询特性

• 前缀查询优化（如查找所有 '@gmail.com' 结尾的邮箱）。
• 模糊查询优化（某些数据库可以优化 LIKE 查询）。

注意事项

1. 权衡写入性能：索引会略微降低 INSERT/UPDATE/DELETE 速度，但对于读取频繁的应用（大多数 Web 应用）利远大于弊。
2. 选择合适的索引类型：普通索引、唯一索引、哈希索引 vs B-tree 索引（根据数据库类型选择）。
3. 长度考虑：对于很长的 email 地址，某些数据库支持前缀索引，例如 MySQL：CREATE INDEX idx_email ON users(email(50));

实际应用示例

-- 创建用户表示例
CREATE TABLE users (
    id INT AUTO_INCREMENT PRIMARY KEY,
    email VARCHAR(255) NOT NULL,
    password_hash VARCHAR(255) NOT NULL,
    -- 其他字段...
    UNIQUE INDEX idx_email (email) -- 唯一索引
);

-- 登录查询将非常高效
EXPLAIN SELECT * FROM users WHERE email = '[email protected]';

为 email 建立索引是数据库设计的最佳实践，特别是对于用户系统这种 email 作为关键检索条件的场景。

前端依赖问题排查

关于前端使用 openapi 报错原因

错误日志显示 Node.js 找不到 tslib 模块：

Error: Cannot find module 'tslib'
Require stack:
D:\bu1\xq\pipei\bushuo-picture-frontend\node_modules\@umijs\openapi\dist\index.js

后端使用的接口文档是 Knife4j，前端 JS 项目遇到此问题。

问题仍然是 Node.js 找不到 tslib 模块，这是一个 TypeScript 运行时库，通常由使用 TypeScript 编写的包依赖。

解决方案

1. 手动安装 tslib

首先确保 tslib 已安装到项目中：

npm install tslib --save

或使用 Yarn：

yarn add tslib

2. 验证依赖结构

检查 node_modules 目录中是否存在 tslib：

ls node_modules/tslib # Linux/macOS
dir node_modules\tslib # Windows

如果不存在，说明安装过程有问题，需要重新安装。

3. 验证 package.json

确保 package.json 中包含 tslib 依赖：

{
  "dependencies": {
    "tslib": "^2.6.2"
  }
}

验证修复

安装完成后，再次运行你的命令：

npm run openapi