一个公司企业官网后端项目

管理员账号：admin 密码：123456

版本

jdk 17
Spring Boot 3.1.2
Mybatis plus 3.5.3.
Mysql 5.7

技术栈

Mybatis
Mybatis-Plus
Swagger2
Lombak
Spring Security 安全认证和授权
Spring Boot Admin 管理和监控Spring Boot应用程序
Spring Boot Data JDBC JDBC访问数据库

项目结构

company_officel_website_server
├── pom.xml
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── cows
│   │               └── common
│   │                   └── api
│   │                   └── config
│   │                   └── constant
│   │                   └── exception
│   │                   └── utils
│   │               └── config
│   │               └── Log
│   │               └── controller
│   │               └── dao
│   │               └── dto
│   │               └── entity
│   │               └── mapper
│   │               └── service
│   │               └── service.impl
│   │               └── hadnler
│   │                   └── 
│   │   └── resources
│   │       └── application.yml
│   └── test
│       └── java
│           └── com
│               └── cows
│                           └── ApplicationTests.java
└── README.md

项目结构

common
- BaseResponse
  - 统一响应返回
  - JsonResult
    - 统一响应返回
service层
- 用于业务逻辑处理
controller层
- 用于接收前端请求
dao层
- 用于数据库操作
entity层
- 实体类
mapper层
- 用于数据库操作
service.impl层
- service接口实现类
dto层
- 用于数据传输
config
- 用于配置文件
utils类
- 工具类
exception类
- 异常类
切面类
- 日志切面

User实体类 -> UserController -> UserService.interface -> UserServiceImpl.java -> UserMapper.interface -> UserMapper.xml

Spring Boot和MyBatis的项目中类和接口有以下的层：

User（实体类）：这是一个模型类，代表了你的业务领域中的一个实体。它通常位于模型层（Model）。
UserController：这是一个控制器类，负责处理HTTP请求和返回HTTP响应。它通常位于控制器层（Controller）。
UserService（接口）：这是一个服务接口，定义了一些业务操作。它通常位于服务层（Service）。
UserServiceImpl（类）：这是UserService接口的一个实现类，提供了具体的业务逻辑。它也位于服务层（Service）。
UserMapper（接口）：这是一个MyBatis的映射器接口，定义了一些与数据库交互的操作。它通常位于数据访问层（DAO或Repository）。
UserMapper.xml：这是一个MyBatis的映射文件，提供了UserMapper接口中定义的操作的SQL查询。它也位于数据访问层（DAO或Repository）。
UserDTO（Data Transfer Object）通常用于服务层和控制器层之间的数据传输。它通常包含了客户端需要的数据，而不是数据库中的所有数据。这样可以减少不必要的数据传输，提高应用程序的性能。在分层架构中，UserDTO通常位于服务层（Service）和控制器层（Controller）之间。服务层会从数据库中获取数据（通常是User实体），然后将这些数据转换为UserDTO，并传递给控制器层。控制器层然后将UserDTO转换为HTTP响应。

分层的架构可以使代码更加模块化，更容易测试和维护。

每一层都有其特定的职责，这样可以降低各层之间的耦合度，提高代码的可重用性。

项目依赖

pom.xml

项目配置

数据库配置

application.properties

切换环境

src/main/resources/application.yml

开发环境

spring:
  profiles:
    active: dev

生效配置：

src/main/resources/application-dev.yml

产线环境

spring:
  profiles:
    active: prod

生效配置：

src/main/resources/application-prod.yml

JDK

（1）下载

cd /usr/local
wget https://download.oracle.com/java/17/latest/jdk-17_linux-x64_bin.tar.gz

（2）解压

tar -xzvf jdk-17_linux-x64_bin.tar.gz

(3)配置环境变量

cd ~
vim /etc/profile

export JAVA_HOME=/usr/local/jdk-17.0.11
export JRE_HOME=/usr/local/jdk-17.0.11/jre
export PATH=$JAVA_HOME/bin:$PATH
export CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar

启动

dev

mvn spring-boot:run

部署

Linux CentOS 部署Docker Linux CentOS 部署JDK

项目切换产线环境

配置前端跨域

允许跨域

com/cows/config/WebConfig.java

@Configuration
@Profile({"dev", "prod"})
public class WebConfig implements WebMvcConfigurer {

  @Value("${cors.allowed-origins}") // Add this line
  private String[] allowedOrigins; // Add this line

  @Bean
  public WebMvcConfigurer corsConfigurer() {
    return new WebMvcConfigurer() {
      @Override
      public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins(allowedOrigins) 
                .allowedMethods("GET", "POST", "PUT", "DELETE", "OPTIONS")
                .allowedHeaders("*")
                .allowCredentials(true);
      }
    };
  }
}

允许跨域

com/cows/config/SecurityConfig.java

@Configuration
@EnableWebSecurity
@Profile({"dev", "prod"})
public class SecurityConfig {

  @Autowired
  private DataSource dataSource;

  @Value("${cors.allowed-origins}")
  private String[] allowedOrigins;
  
@Bean
public CorsConfigurationSource corsConfigurationSource() {
        CorsConfiguration configuration = new CorsConfiguration();
        configuration.setAllowedOrigins(Arrays.asList(allowedOrigins)); 
        configuration.setAllowedMethods(Arrays.asList("GET", "POST", "PUT", "DELETE", "OPTIONS"));
        configuration.setAllowedHeaders(Arrays.asList("*"));
        configuration.setAllowCredentials(true);

        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**", configuration);
        return source;
        }

配置具体跨域地址

application-prod.yml

cors:
  allowed-origins: http://81.71.17.188:9000

application-dev.yml

cors:
  allowed-origins: http://127.0.0.1:9000

数据库地址和端口

配置

application-prod.yml 和 application-dev.yml

spring:
        # 配置Mybatis
        datasource:
        url: jdbc:mysql://127.0.0.1:3306/springBootTest
        username: root
        password: lyc123456
        driver-class-name: com.mysql.cj.jdbc.Driver

引用

mybatis/mybatis-config.xml

 <dataSource type="POOLED">
  <!-- 数据库驱动类名 -->
  <property name="driver" value="${spring.datasource.driver-class-name}"/>
  <!-- 连接数据库的URL字符串 -->
  <property name="url" value="${spring.datasource.url}"/>
  <!-- 访问数据库的用户名 -->
  <property name="username" value="${spring.datasource.username}"/>
  <!-- 访问数据库的密码 -->
  <property name="password" value="${spring.datasource.password}"/>
</dataSource>

打jar包

mvn clean package -Dmaven.test.skip=true

target/com.cows-0.0.1-SNAPSHOT.jar

运行jar包

无窗口化运行

nohup java -jar back_server-0.0.1-SNAPSHOT.jar > app.log 2>&1 &

nohup：使程序在退出终端后继续运行。
java -jar your-app.jar：运行 JAR 文件。
app.log：将标准输出重定向到 app.log 文件。
2>&1：将标准错误输出也重定向到 app.log。
&：将进程放入后台运行。
查看日志：你可以使用 tail -f app.log 来实时查看日志输出。

手动测试

java -jar back_server-0.0.1-SNAPSHOT.jar

容器化部署

docker build -t your-app-name .
docker run -p 8080:8080 your-app-name

创建上传文件夹

在jar包所在根目录创建一个文件夹名问upload，用于存放上传的文件

数据库

DBeaver连接mysql提示Public Key Retrieval is not allowed 账号和密码都正确，如何解决？

解决办法：

在 DBeaver 中，编辑你的 MySQL 连接，添加以下参数到 JDBC URL 中：

在连接URL中添加参数：allowPublicKeyRetrieval=true

jdbc:mysql://localhost:3306/your_database?allowPublicKeyRetrieval=true

DBeaver导出表直接导入到产线数据库中

创建数据库springBootTest，默认字符集utf8mb4，默认排序规则utf8mb4_general_ci，打开本地数据库，选择所有表，右击“导出数据”，导出目标选择“数据库”，目标容器选择，选择产线数据库springBootTest

备注：腾讯云端口开启3306和8088

表

User表

CREATE TABLE `User` (
  `id` int(100) NOT NULL AUTO_INCREMENT,
  `userName` varchar(100) DEFAULT NULL,
  `password` varchar(100) DEFAULT NULL,
  `created` datetime DEFAULT CURRENT_TIMESTAMP,
  `isEnable` tinyint(1) DEFAULT '1',  -- 修改字段名
  `isDeleted` tinyint(1) DEFAULT '0',  -- 新增字段
  `wechat_openid` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=472 DEFAULT CHARSET=utf8

后台管理员表

CREATE TABLE `Admins` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `userName` varchar(255) NOT NULL,
  `password` varchar(255) NOT NULL,
  `permissions` varchar(255) DEFAULT NULL,
  `createTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updateTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `remarks` text,
  `isDeleted` tinyint(1) DEFAULT '0',
  `isEnable` tinyint(1) DEFAULT '1',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=13 DEFAULT CHARSET=utf8

轮播图表

CREATE TABLE `Carousels` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `imageUrl` varchar(255) NOT NULL,
  `redirectUrl` varchar(255) DEFAULT NULL,
  `isEnabled` tinyint(1) DEFAULT '1',
  `createTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updateTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `isDeleted` tinyint(1) DEFAULT '0',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=8 DEFAULT CHARSET=utf8

基础信息

CREATE TABLE `BasicInformation` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `phone` varchar(255) NOT NULL,
  `email` varchar(255) NOT NULL,
  `address` varchar(255) NOT NULL,
  `weChatImage` varchar(255) DEFAULT NULL,
  `icp` varchar(255) DEFAULT NULL,
  `beianImage` varchar(255) DEFAULT NULL,
  `publicSecurity` varchar(255) DEFAULT NULL,
  `copyright` varchar(255) DEFAULT NULL,
  `isDeleted` tinyint(1) DEFAULT '0',
  `isEnable` tinyint(1) DEFAULT '1',
  `createTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updateTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8

横向商品轮播图表

CREATE TABLE `ProductsCarousels` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `products` json NOT NULL,
  `createTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updateTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `isDeleted` tinyint(1) DEFAULT '0',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8

商品品牌

CREATE TABLE `Brands` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) NOT NULL,
  `description` text,
  `logo` varchar(255) DEFAULT NULL,
  `createTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updateTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `isDeleted` tinyint(1) DEFAULT '0',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8

商品分类表

CREATE TABLE `ProductCategories` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '商品分类ID',
  `name` varchar(255) NOT NULL COMMENT '商品分类名称',
  `description` text COMMENT '商品分类描述',
  `isEnabled` tinyint(1) DEFAULT '1' COMMENT '启用禁用状态',
  `isDeleted` tinyint(1) DEFAULT '0' COMMENT '是否删除',
  `updateTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `createTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=8 DEFAULT CHARSET=utf8 COMMENT='商品分类表'

商品信息表（商品详情）

CREATE TABLE `Products` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '商品ID',
  `name` varchar(255) NOT NULL COMMENT '商品名称',
  `coverImage` varchar(255) DEFAULT NULL COMMENT '商品封面图片',
  `detailImages` json DEFAULT NULL COMMENT '商品详情图片',
  `description` text COMMENT '商品描述',
  `salePrice` decimal(10,2) NOT NULL COMMENT '销售价格',
  `costPrice` decimal(10,2) NOT NULL COMMENT '成本价格',
  `stockQuantity` int(11) NOT NULL COMMENT '库存数量',
  `brand` varchar(255) DEFAULT NULL COMMENT '商品品牌',
  `categoryId` int(11) DEFAULT NULL COMMENT '商品分类ID',
  `isAvailable` tinyint(1) DEFAULT '1' COMMENT '上下架状态',
  `isDeleted` tinyint(1) DEFAULT '0' COMMENT '是否删除',
  `updateTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `createTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`),
  KEY `categoryId` (`categoryId`),
  CONSTRAINT `Products_ibfk_1` FOREIGN KEY (`categoryId`) REFERENCES `ProductCategories` (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8 COMMENT='商品信息表'

商品信息取商品分类id作为外键

品牌授权书

CREATE TABLE BrandAuthorizationCertificates (
    id INT AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(255) NOT NULL COMMENT '证书名称',
    description TEXT COMMENT '证书描述',
    imageUrl VARCHAR(255) COMMENT '证书图片URL地址',
    createTime TIMESTAMP DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
    updateTime TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
    isDeleted BOOLEAN DEFAULT FALSE COMMENT '是否删除'
);

招商加盟

CREATE TABLE `Businesses` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) NOT NULL,
  `description` text NOT NULL,
  `contactInfo` varchar(255) NOT NULL,
  `createTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updateTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `isDeleted` tinyint(1) DEFAULT '0',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

关于我们

CREATE TABLE `About` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `imageUrl` varchar(255) NOT NULL,
  `description` varchar(255) DEFAULT NULL,
  `createTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updateTime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `isDeleted` tinyint(1) DEFAULT '0',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

Orders表

CREATE TABLE `Orders` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `userId` int(11) DEFAULT NULL,
  `totalPrice` decimal(10,2) NOT NULL,
  `status` varchar(50) DEFAULT NULL,
  `createTime` datetime DEFAULT CURRENT_TIMESTAMP,
  `updateTime` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`),
  KEY `userId` (`userId`),
  CONSTRAINT `Orders_ibfk_1` FOREIGN KEY (`userId`) REFERENCES `User` (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=31 DEFAULT CHARSET=utf8

user_location

CREATE TABLE `user_location` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `user_id` int(11) NOT NULL,
  `latitude` decimal(9,6) DEFAULT NULL,
  `longitude` decimal(9,6) DEFAULT NULL,
  `address` varchar(255) DEFAULT NULL,
  `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`),
  KEY `user_id` (`user_id`),
  CONSTRAINT `user_location_ibfk_1` FOREIGN KEY (`user_id`) REFERENCES `User` (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8

金刚区表
商品瀑布流表
商品评论表
商品收藏表
商品搜索表
商品搜索历史表
商品搜索推荐表
商品搜索推荐历史表

本地mysql数据库的表导出sql文件，并在云服务器上面导入

菜单：数据库 > 工具 > 转存数据库

restfull API

登录接口（JWT）

com/cows/config/SecurityConfig.java

配置允许未认证访问的接口

 @Bean
    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
        http
            .authorizeRequests(authorize -> authorize
                .requestMatchers("/", "/home", "/login", "/login/wechat", "/login/wechat/callback", "/login/perform_login","/v1/users/addUser").permitAll()// 允许未认证访问 
                .anyRequest().authenticated()
            )
            .formLogin(form -> form
                .loginPage("/login")
                .defaultSuccessUrl("/home")
                .permitAll()
            )
            .logout(logout -> logout
                .permitAll()
            )
            .csrf().disable();  // 如果你使用POST方法，可能需要禁用CSRF保护
        return http.build();
    }

配置your_secret_key、设置token有效时长

src/main/java/com/cows/util/JwtUtil.java

private static final String SECRET_KEY = "your_secret_key";

src/main/java/com/cows/security/JwtAuthenticationFilter.java

private final String secretKey = "your_secret_key";

配置token时效性

 public static String generateToken(String username) {
        return Jwts.builder()
        .setSubject(username)
        .setIssuedAt(new Date())
        .setExpiration(new Date(System.currentTimeMillis() + 1000 * 60 * 60 * 1)) // 1 hours
        .signWith(SignatureAlgorithm.HS256, SECRET_KEY)
        .compact();
        }

controller.com.cows.UserController

GET

示例1：

   /**
     * @author: liyinchi
     * @description 通过获取所有用户信息
     * @mark
     * */
    @Operation(summary = "获取所有用户", description = "返回所有用户的列表")
    @RequestMapping(value = "/getAllUsers", method = RequestMethod.GET,produces = "application/json; charset=UTF-8")
    public BaseResponse<List<UserDTO>> getAllUsers() {
        List<User> users = userService.getAllUsers();
        List<UserDTO> userDTOs = users.stream().map(this::convertToDto).collect(Collectors.toList());
        log.info("=======getAllUsers: " + userDTOs);
        return BaseResponse.success(userDTOs);
    }

返回数据 List
示例2：

   /**
     * @author: liyinchi
     * @description 通过ID获取用户信息
     * @mark    /getUserById/{id}
     * */
    @Operation(summary = "通过ID获取用户", description = "返回指定ID的用户")
    @RequestMapping(value = "/getUserById/{id}", method = RequestMethod.GET, produces = "application/json; charset=UTF-8")
    public BaseResponse<UserDTO> getUserById(@Parameter(description = "用户ID", required = true) @PathVariable int id) {
        User user = userService.getUserById(id);
        log.info("=======getUserById user:{}", user);
        return BaseResponse.success(convertToDto(user));
    }

返回数据 List

示例3：

     /**
     * @author: liyinchi
     * @description 通过ID获取用户信息
     * @mark    ?id=1&name=liyinchi
     * */
    @Operation(summary = "通过ID参数获取用户", description = "返回指定ID的用户")
    @RequestMapping(value = "/getUserByIdParam", method = RequestMethod.GET, produces = "application/json; charset=UTF-8")
    public BaseResponse<UserDTO> getUserByIdParam(@Parameter(description = "用户ID", required = true) @RequestParam("id") int id) {
        User user = userService.getUserById(id);
        log.info("=======getUserByIdParam user:{}", user);
        return BaseResponse.success(convertToDto(user));
    }

返回数据 List

分页查询

在Spring Boot中，我们可以使用Spring Data JPA的分页功能来实现分页查询。

以下是一个简单的例子：

（1）首先，你需要在UserMapper接口中添加一个新的方法，该方法接收一个RowBounds对象和一个排序字段名作为参数，并返回一个List对象：

UserMapper.java

public interface UserMapper {
    // 其他方法...

    // 分页查询
    List<User> getAllUsers(int offset, int limit, String sortField);
}

（2）然后，在你的UserMapper.xml文件中，你需要添加一个新的SQL查询，该查询使用ORDER BY子句来排序结果，并使用LIMIT和OFFSET子句来实现分页：

UserMapper.xml

<select id="getAllUsers" resultType="com.cows.entity.User">
  SELECT * FROM User ORDER BY ${sortField} LIMIT #{limit} OFFSET #{offset}
</select>

（3）接下来，在UserService接口中，你需要添加一个新的方法，该方法接收页码、页大小和排序字段名作为参数，并返回一个List对象：

UserService.java

    public interface UserService {
    // 分页查询
    List<User> getAllUsers(int page, int size, String sortField);
                                }

（4）然后，在你的UserServiceImpl类中实现这个方法：

UserServiceImpl.java

 @Override
public List<User> getAllUsers(int page, int size, String sortField) {
        log.debug("page" + page + " size" + size + " sortField" + sortField);
        // 检查page和size参数的有效性
        if (page < 0 || size <= 0) {
        throw new IllegalArgumentException("Page must be non-negative and size must be positive");
        }

        // 检查sortField参数的有效性
        if (sortField == null || sortField.isEmpty()) {
        sortField = "id";  // 使用一个默认的排序字段
        }

        int offset = page * size;
        return userMapper.getAllUsers(offset, size, sortField);
                                                                    }

（5）最后，在你的UserController类中，你可以添加一个新的方法来处理分页和排序的请求：

UserController.java

    /**
 * @author: liyinchi
 * @description 分页查询
 * @param page 页码
 * @param size 每页显示条数
 * @return object
 * */
@GetMapping("/getAllUsersPagedSorted")
public BaseResponse<List<UserDTO>> getAllUsersPagedSorted(@RequestParam int page, @RequestParam int size, @RequestParam String sortField) {
        List<User> users = userService.getAllUsers(page, size, sortField);
        List<UserDTO> userDTOs = users.stream().map(this::convertToDto).collect(Collectors.toList());
        return BaseResponse.success(userDTOs);
        }

在这个例子中，客户端可以通过发送一个GET请求到/getAllUsersPagedSorted，并在请求参数中指定page，size和sortField来获取分页和排序的用户列表。

例如，发送一个请求到/getAllUsersPagedSorted?page=0&size=10&sortField=userName将返回第一页的10个用户，并按照userName字段进行排序，例如：id。

POST

示例1：

   /**
     * @author: liyinchi
     * @description 新增用户
     * @mark json
     * */
    // 定义一个处理POST请求的方法，路径为"/addUser"，返回的数据类型为JSON
    @Operation(summary = "新增用户", description = "通过JSON数据新增用户")
    @RequestMapping(value = "/addUser", method = RequestMethod.POST,produces = "application/json; charset=UTF-8")
    // 该方法接收一个参数，即UserDTO对象，这个对象是通过@RequestBody注解从请求体中获取的
    public BaseResponse<UserIdResponseDTO> addUser(@Parameter(description = "用户数据", required = true) @RequestBody UserDTO userDto) {
        // 调用convertToEntity方法，将UserDTO对象转换为User对象
        User user = convertToEntity(userDto);
        // 调用userService的addUser方法，将User对象添加到数据库中
        int newUserId = userService.addUser(user);
        // 记录日志，输出添加的User对象的信息
        log.info("=======addUser:{}", user);
        // 返回一个表示操作成功的BaseResponse对象
        return BaseResponse.success(new UserIdResponseDTO(newUserId));
    }

返回数据 Object

示例2：

    /**
     * @author: liyinchi
     * @description 新增用户
     * @mark 表单
     *
     * */
    // 定义一个处理POST请求的方法，路径为"/addUserFormData"，返回的数据类型为JSON
    @Operation(summary = "新增用户（表单）", description = "通过表单数据新增用户")
    @RequestMapping(value = "/addUserFormData", method = RequestMethod.POST,produces = "application/json; charset=UTF-8")
    // 该方法接收三个参数，分别是id，userName和password，这些参数都是通过@RequestParam注解从请求中获取的
    public BaseResponse<UserIdResponseDTO> addUserFormData(@Parameter(description = "用户名", required = true) @RequestParam("userName") String userName,
                                                           @Parameter(description = "密码", required = true) @RequestParam("password") String password){
        // 创建一个新的UserDTO对象
        UserDTO userDto = new UserDTO();
        // 将从请求中获取的参数设置到UserDTO对象中
        userDto.setUserName(userName);
        userDto.setPassword(password);
        // 调用convertToEntity方法，将UserDTO对象转换为User对象
        User user = convertToEntity(userDto);
        // 记录日志，输出添加的User对象的信息
        log.info("=======addUserFormData:{}", user);
        // 调用userService的addUser方法，将User对象添加到数据库中
        int newUserId = userService.addUser(user);
        // 返回一个表示操作成功的BaseResponse对象
        return BaseResponse.success(new UserIdResponseDTO(newUserId));
    }

返回数据 Object

PUT

示例1：

/**
     * @author: liyinchi
     * @description 更新用户
     * @mark json
     * */
    @Operation(summary = "更新用户", description = "通过JSON数据更新用户")
    // 定义一个处理PUT请求的方法，路径为"/updateUser"，返回的数据类型为JSON
    @RequestMapping(value = "/updateUser", method = RequestMethod.PUT,produces = "application/json; charset=UTF-8")
    // 该方法接收一个参数，即UserDTO对象，这个对象是通过@RequestBody注解从请求体中获取的
    public BaseResponse<UpdateUserResponseDTO> updateUser(@Parameter(description = "用户数据", required = true) @RequestBody UserDTO userDto) {
        // 调用convertToEntity方法，将UserDTO对象转换为User对象
        User user = convertToEntity(userDto);
        // 调用userService的updateUser方法，将User对象的信息更新到数据库中
        int updates = userService.updateUser(user);
        // 记录日志，输出更新的User对象的信息
        log.info("=======updateUser:{}", user);
        // 返回一个表示操作成功的BaseResponse对象
        return BaseResponse.success(new UpdateUserResponseDTO(user.getId(), updates));
    }

返回数据

DELETE

示例1：

/**
     * @author: liyinchi
     * @description 删除用户
     * @param request object {"id":4}
     * @return object
     * */
    // 定义一个处理DELETE请求的方法，路径为"/deleteUser"，返回的数据类型为JSON
    @Operation(summary = "删除用户", description = "通过JSON数据删除用户")
    @RequestMapping(value = "/deleteUser", method = RequestMethod.DELETE,produces = "application/json; charset=UTF-8")
    // 该方法接收一个参数，即DeleteUserRequestDTO对象，这个对象是通过@RequestBody注解从请求体中获取的
    public BaseResponse<DeleteUserResponseDTO>  deleteUser(@Parameter(description = "删除用户请求数据", required = true)  @RequestBody DeleteUserRequestDTO request) {
        // 调用userService的deleteUser方法，根据请求中的id删除数据库中的用户
        int updates = userService.deleteUser(request.getId());// 获取请求参数id值
        // 记录日志，输出删除的用户的请求信息
        log.info("=======deleteUser:{}", request);
        // 返回一个表示操作成功的BaseResponse对象
        return BaseResponse.success(new DeleteUserResponseDTO(request.getId(), updates));
    }

返回数据

示例2：

  /**
     * @author: liyinchi
     * @description 删除用户
     * @mark  请求参数在URI中
     * @param id 用户ID
     * @return String
     *
     * */
    @Operation(summary = "通过ID删除用户", description = "删除指定ID的用户")
    @RequestMapping(value = "/deleteUserPath/{id}", method = RequestMethod.DELETE,produces = "application/json; charset=UTF-8")
    public BaseResponse<UserIdResponseDTO> deleteUserPath(@Parameter(description = "用户ID", required = true) @PathVariable int id) { // id在URI中
        userService.deleteUser(id);
        log.info("=======deleteUserPath:{}", id);
        return BaseResponse.success(new UserIdResponseDTO(id));
    }

返回数据

示例3：

 /**
     * @author: liyinchi
     * @description 删除用户
     * @mark 请求参数在URI中 ?id=
     * @param id 用户ID
     * @return object
     *
     * */
    @Operation(summary = "通过ID参数删除用户", description = "删除指定ID的用户")
    @RequestMapping(value = "/deleteUserParam", method = RequestMethod.DELETE,produces = "application/json; charset=UTF-8")
    public BaseResponse<UserIdResponseDTO> deleteUserParam(@Parameter(description = "用户ID", required = true) @RequestParam("id") int id) { // id在URI中
        userService.deleteUser(id);
        log.info("=======deleteUserParam:{}", id);
        return BaseResponse.success(new UserIdResponseDTO(id));
    }

返回数据

配置跨域 CORS

方法一：全局配置 CORS

在 Spring Boot 项目的配置类中添加全局 CORS 配置：

com/cows/config/WebConfig.java

@Configuration
@Profile({"dev", "prod"})
public class WebConfig implements WebMvcConfigurer {

  @Value("${cors.allowed-origins}")
  private String[] allowedOrigins;

  @Bean
  public WebMvcConfigurer corsConfigurer() {
    return new WebMvcConfigurer() {
      @Override
      public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins(allowedOrigins) // 允许跨域
                .allowedMethods("GET", "POST", "PUT", "DELETE", "OPTIONS")
                .allowedHeaders("*")
                .allowCredentials(true);
      }
    };
  }
}

方法二：在特定的控制器中配置 CORS 如果你只想为特定的控制器配置 CORS，可以在控制器类上使用 @CrossOrigin 注解：

import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
@CrossOrigin(origins = "http://localhost:8080") // 前端项目的地址
public class YourController {

    @GetMapping("/example")
    public String example() {
        return "Hello, CORS!";
    }
}

方法三：全局配置 CORS 过滤器

也可以通过配置一个 CORS 过滤器来解决跨域问题：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.filter.CorsFilter;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;

@Configuration
public class CorsConfig {

    @Bean
    public CorsFilter corsFilter() {
        CorsConfiguration config = new CorsConfiguration();
        config.addAllowedOrigin("http://localhost:8080"); // 前端项目的地址
        config.addAllowedHeader("*");
        config.addAllowedMethod("*");
        config.setAllowCredentials(true);

        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**", config);

        return new CorsFilter(source);
    }
}

H5微信授权登录

微信公众号配置

公众号设置-功能设置-JS接口安全域名

1.下载验证文本文件，放到/static/底下

2.设置这个静态文件无需鉴权登录即可访问

src/main/java/com/cows/config/SecurityConfig.java

@Bean
    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
        http
            .addFilterBefore(new JwtAuthenticationFilter(), UsernamePasswordAuthenticationFilter.class)// 添加JWT过滤器
            .authorizeRequests(authorize -> authorize
                .requestMatchers("/MP_verify_tSDyEHEKTxbBXHMd.txt").permitAll()// 允许未认证访问
                .anyRequest().authenticated()
            )

验证token

接口请求顺序

用户点击H5页面的登录按钮
(1) H5页面发送请求到后端接口/login/wechat
(2) /login/wechat接口返回一个重定向的URL，用户点击后会跳转到微信的授权页面，用户同意授权后，会重定向到/login/wechat/callback接口，并携带code参数。
(3) /login/wechat/callback接口接收到code参数后，调用微信的接口，使用code换取access_token和openid，然后将用户信息存储到数据库中，最后返回一个登录成功的响应。
(4) H5页面接收到登录成功的响应后，进行相应的处理，比如跳转到其他页面或显示登录成功的提示信息。
(5) 用户在微信的授权页面中点击拒绝授权后，H5页面会接收到一个错误提示，可以根据错误提示进行相应的处理。
(6) 用户在微信的授权页面中点击取消授权后，H5页面会接收到一个错误提示，可以根据错误提示进行相应的处理。
(7) 用户在微信的授权页面中点击返回后，H5页面会接收到一个错误提示，可以根据错误提示进行相应的处理。
(8) 用户在微信的授权页面中点击其他页面后，H5页面会接收到一个错误提示，可以根据错误提示进行相应的处理。
(9) 用户在微信的授权页面中点击其他操作后，H5页面会接收到一个错误提示，可以根据错误提示进行相应的处理。

WechatService.java

在WechatService中，你可能需要构建一个URL来重定向用户到微信的授权页面。这通常在控制器中完成，如loginController的wechatLogin方法。
如果你需要在WechatService中使用这个URL，可以通过注入同样的方式获取：

WechatUser.java

loginController.java

AppConfig.java

application-dev.yml

wechat:
  appid:   # 微信应用ID
  secret:   # 微信应用密钥
  redirect:
    uri:  https://xxxx/login/wechat/callback # 回调URL

遇到问题1： “Scope 参数错误或没有 Scope 权限，错误码：10005”

解决办法：

1：使用的是订阅号，订阅号没有权限使用网页授权，详细可参考接口权限：https://developers.weixin.qq.com/doc/offiaccount/Getting_Started/Explanation_of_interface_privileges.html
2：需要已认证的服务号
3：网页授权回调域名填写错误
4：Scope参数顺序不对
5：服务号不支持扫码登录，要网站应用才支持：https://developers.weixin.qq.com/doc/oplatform/Website_App/WeChat_Login/Wechat_Login.html
6：snsapi_userinfo的接口权限被封

关于网页授权的两种scope的区别说明

以snsapi_base为scope发起的网页授权，是用来获取进入页面的用户的openid的，并且是静默授权并自动跳转到回调页的。用户感知的就是直接进入了回调页（往往是业务页面）
以snsapi_userinfo为scope发起的网页授权，是用来获取用户的基本信息的。但这种授权需要用户手动同意，并且由于用户同意过，所以无须关注，就可在授权后获取该用户的基本信息。

用户管理类接口中的“获取用户基本信息接口”，是在用户和公众号产生消息交互或关注后事件推送后，才能根据用户OpenID来获取用户基本信息。这个接口，包括其他微信接口，都是需要该用户（即openid）关注了公众号后，才能调用成功的。

参考（微信H5网页授权）：https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html
参考：https://developers.weixin.qq.com/community/develop/doc/000ea06c4acc586aa92c42e1657809?_at=1718284485467

遇到问题2：微信公众号一侧提交URL、Token、EncodingAESKey，但提示“系统发生错误，请稍后重试”

解决办法：

1. URL不可访问：确保你的Spring Boot应用部署在一个公网可访问的服务器上，并且可以通过微信公众号配置的URL地址直接访问到你的接口
1. Token验证失败：在你的接口中，确保对微信发送的Token验证请求进行正确的签名验证。检查你的签名验证逻辑是否正确，包括对signature、timestamp和nonce的处理。
1. EncodingAESKey配置错误：如果你启用了消息加解密功能，确保在微信公众号配置中填写的EncodingAESKey与你应用中的加解密逻辑一致。
1. 服务器响应格式不正确：在接收到微信的验证请求时，确保你的接口返回的响应格式符合微信的要求，即只返回echostr参数的值。
1. 网络问题：有时候网络连接不稳定或延迟可能导致微信公众号无法正确访问你的接口。确保你的服务器网络连接正常。

JSSDK

微信JS-SDK 主要用于在微信内的网页上调用微信的功能，如:获取用户地理位置、微信支付、分享等。如果你需要在你的H5页面中使用这些功能，或者需要通过微信网页直接获取用户信息而不是重定向，那么你应该引入和配置JS-SDK。

如果你的目的是让用户点击按钮后通过重定向到微信授权页面进行登录，那么不需要引入微信JS-SDK。这种情况下，用户的登录流程是完全由后端处理的，前端只负责触发重定向。

引入JS-SDK:

在你的HTML页面中，添加以下脚本标签来引入微信JS-SDK。

   <script src="https://res.wx.qq.com/open/js/jweixin-1.6.0.js"></script>

配置JS-SDK:

需要后端提供JS-SDK的配置信息，包括appId, timestamp, nonceStr, signature等。这些信息需要通过调用微信的接口获得。

配置示例如下：

   wx.config({
       debug: true, // 开启调试模式
       appId: '你的AppID', // 必填，公众号的唯一标识
       timestamp: '生成签名的时间戳', // 必填，生成签名的时间戳
       nonceStr: '生成签名的随机串', // 必填，生成签名的随机串
       signature: '签名', // 必填，签名
       jsApiList: ['checkJsApi', 'onMenuShareTimeline', 'onMenuShareAppMessage'] // 必填，需要使用的JS接口列表
   });

发起微信登录请求:

使用JS-SDK来处理登录，可以使用wx.login方法来发起微信登录请求。

   wx.login({
       success: function(res) {
           if (res.code) {
               // 使用返回的code去后端换取access_token等信息
           } else {
               console.log('登录失败！' + res.errMsg);
           }
       }
   });

使用jssdk

<script>
wx.ready(function() {
    // 获取地理位置
    wx.getLocation({
        type: 'wgs84',
        success: function (res) {
            var latitude = res.latitude; // 纬度，浮点数，范围为90 ~ -90
            var longitude = res.longitude; // 经度，浮点数，范围为180 ~ -180。
            var speed = res.speed; // 速度，以米/每秒计
            var accuracy = res.accuracy; // 位置精度
            alert('Latitude: ' + latitude + '\nLongitude: ' + longitude);
        }
    });

    // 配置分享给朋友的信息
    wx.updateAppMessageShareData({ 
        title: '分享标题', // 分享标题
        desc: '分享描述', // 分享描述
        link: 'https://yourwebsite.com', // 分享链接
        imgUrl: 'https://yourwebsite.com/image.jpg', // 分享图标
        success: function () {
          // 设置成功
          alert('已分享');
        }
    });

    // 配置分享到朋友圈的信息
    wx.updateTimelineShareData({ 
        title: '分享标题', // 分享标题
        link: 'https://yourwebsite.com', // 分享链接
        imgUrl: 'https://yourwebsite.com/image.jpg', // 分享图标
        success: function () {
          // 设置成功
          alert('已分享到朋友圈');
        }
    });
});
</script>

使用wx.getUserInfo方法来获取用户信息。

wx.getUserInfo({
          success: function(res) {
          var userInfo = res.userInfo;
          // 在这里可以对用户信息进行处理
      },
      fail: function(res) {
          // 获取用户信息失败的处理
      }
  });

使用wx.login方法来获取用户的code。

wx.login({
      success: function(res) {
          if (res.code) {
              // 可以使用code去换取用户的openid和session_key
          } else {
                        console.log('登录失败！' + res.errMsg)
          }
      },
      fail: function(res) {
          console.log(res);
      }
  });

使用wx.request方法来向服务器发送请求。

wx.request({
      url: 'https://yourwebsite.com/api', // 服务器接口地址
      data: {
          code: res.code // 用户的code
      },
      method: 'POST',
      header: {
                  
              }
      }
}

错误处理

<script>
wx.error(function(res){
    // config信息验证失败会执行error函数，如签名过期导致验证失败
    alert("Error: " + res.errMsg);
});
</script>

网页扫码登录

B站教程视频

B站教程视频-黑马程序员

swagger接口文档

http://localhost:8088/swagger-ui.html

http://localhost:8088/swagger-ui/index.html?urls.primaryName=public#/

全局异常处理

com.lyc.springboot.demo.common.exception.GlobalExceptionHandler

业务异常（枚举异常）

com.lyc.springboot.demo.common.exception.BusinesusinessMsgEnums

参数缺失

com.lyc.springboot.demo.common.exception.GlobalExceptionHandler

 /**
     * 缺少请求参数异常
     * @param ex HttpMessageNotReadableException
     * @return
     */
    @ExceptionHandler(MissingServletRequestParameterException.class)
    @ResponseStatus(value = HttpStatus.BAD_REQUEST)
    public BaseResponse handleHttpMessageNotReadableException(MissingServletRequestParameterException ex) {
        log.error("缺少请求参数，{}", ex.getMessage());
        return new BaseResponse(400, "缺少必要的请求参数");
    }

处理空指针异常

com.lyc.springboot.demo.common.exception.GlobalExceptionHandler

 /**
     * 系统异常 预期以外异常
     * @param ex
     * 项目中，我们一般都会比较详细的去拦截一些常见异常，拦截 Exception 虽然可以一劳永逸，但是不利于我们去排查或者定位问题。
     * 实际项目中，可以把拦截 Exception 异常写在 GlobalExceptionHandler 最下面，如果都没有找到，最后再拦截一下 Exception 异常，保证输出信息友好
     *
     */
    @ExceptionHandler(Exception.class)
    @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
    public BaseResponse handleUnexpectedServer(Exception ex) {
        log.error("系统异常：", ex);
        return new BaseResponse(500, "系统未知异常，请联系管理员");
    }

所有不可知的异常(不推荐)

com.lyc.springboot.demo.common.exception.GlobalExceptionHandler

  /**
     * @Description: 所有不可知的异常
     * @param ex
     * @return
     */
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public ResponseEntity<String> handleHttpMessageNotReadableException(HttpMessageNotReadableException ex) {
        // 这里可以记录日志，发送通知等
        return new ResponseEntity<>("请求参数错误", HttpStatus.BAD_REQUEST);
    }

处理数组越界异常

com.lyc.springboot.demo.common.exception.GlobalExceptionHandler

  /**
     * 处理数组越界异常
     * */
    @ExceptionHandler(IndexOutOfBoundsException.class)
    @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
    public BaseResponse handleIndexOutOfBoundsException(IndexOutOfBoundsException ex) {
        log.error("数组越界异常，{}", ex.getMessage());
        return new BaseResponse(500, "数组越界异常了");
    }

一劳永逸异常

com.lyc.springboot.demo.common.exception.GlobalExceptionHandler

 /**
     * 系统异常（预期意外）
     * @param ex
     * 项目中，我们一般都会比较详细的去拦截一些常见异常，拦截 Exception 虽然可以一劳永逸，但是不利于我们去排查或者定位问题。
     * 实际项目中，可以把拦截 Exception 异常写在 GlobalExceptionHandler 最下面，如果都没有找到，最后再拦截一下 Exception 异常，保证输出信息友好
     *
     */
    @ExceptionHandler(Exception.class)
    @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
    public BaseResponse handleUnexpectedServer(Exception ex) {
        log.error("系统异常：", ex);
        return new BaseResponse(500, "系统未知异常，请联系管理员");
    }

全局返回结果处理

com.lyc.springboot.demo.common.api.BaseResponse

处理成功返回结果

   public BaseResponse() {
        this.code = 0;
        this.message = "success";
    }

处理失败返回结果

统一日志处理

com.cows.common.config.LogAspect

文件上传

com/cows/controller/UploadController.java

接收上传文件，存放在指定路径下

**
 * 文件上传
 * 限制上传大小、文件格式、存放位置、重命名上传文件
 * */
@Slf4j
@RestController
@RequestMapping("/v1/fileUpload")
@Schema(name="文件上传", description="文件上传")
@Tag(name = "文件上传")
public class UploadController {
    private static final String UPLOAD_DIR = "./upload";

    @PostMapping("/upload")
    public BaseResponse<String> handleFileUpload(@RequestParam("file") MultipartFile file, @RequestParam("userId") String userId) {
        String originalFilename = file.getOriginalFilename();
        String fileExtension = originalFilename.substring(originalFilename.lastIndexOf(".") + 1);
        // 限制上传文件大小
        if (file.getSize() > 1024 * 1024 * 5) {
            return new BaseResponse<>(1, "File size too large", null);
        }
        // 限制上传文件格式
        if (!"jpg".equals(fileExtension) && !"png".equals(fileExtension)) {
            return new BaseResponse<>(1, "Invalid file format", null);
        }

        // Rename the file
        String timestamp = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyyMMddHHmmss"));
        String newFilename = userId + "_" + timestamp + "_" + originalFilename;

        // Save the file to the server
        Path filePath = Paths.get(UPLOAD_DIR, newFilename);
        try {
            Files.write(filePath, file.getBytes());
        } catch (IOException e) {
            e.printStackTrace();
            return new BaseResponse<>(1, "Failed to save file", null);
        }

        return new BaseResponse<>(0, "File uploaded successfully", newFilename);
    }
}

理想状态是接收上传的文件，存放在阿里云OSS上

import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import api.commons.com.cows.BaseResponse;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import java.io.ByteArrayInputStream;
import java.io.IOException;

@RestController
public class UploadController {

  @Value("${aliyun.oss.endpoint}")
  private String endpoint;

  @Value("${aliyun.oss.accessKeyId}")
  private String accessKeyId;

  @Value("${aliyun.oss.accessKeySecret}")
  private String accessKeySecret;

  @Value("${aliyun.oss.bucketName}")
  private String bucketName;

  @PostMapping("/upload")
  public BaseResponse<String> handleFileUpload(@RequestParam("file") MultipartFile file) {
    String filename = file.getOriginalFilename();
    String fileExtension = filename.substring(filename.lastIndexOf(".") + 1);
    if (!"jpg".equals(fileExtension) && !"png".equals(fileExtension)) {
      return new BaseResponse<>(1, "Invalid file format", null);
    }

    // Create an OSSClient instance
    OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);

    try {
      // Upload the file to OSS
      ossClient.putObject(bucketName, filename, new ByteArrayInputStream(file.getBytes()));
    } catch (IOException e) {
      e.printStackTrace();
      return new BaseResponse<>(1, "Failed to upload file", null);
    } finally {
      // Shut down the OSSClient
      ossClient.shutdown();
    }

    return new BaseResponse<>(0, "File uploaded successfully", filename);
  }
}

生成工具

快速实现实体类、mapper、数据库表字段

com/example/lyc/springboot/demo/util/MybatisGenerator.java

切面

日志切面

com/example/lyc/springboot/demo/handler/LogAspectHandler.java

@Pointcut：定义一个切面，即上面所描述的关注的某件事入口。
@Before：在做某件事之前做的事。
@After：在做某件事之后做的事。
@AfterReturning：在做某件事之后，对其返回值做增强处理。
@AfterThrowing：在做某件事抛出异常时，处理。

@Before 注解

指定的方法在切面切入目标方法之前执行

可以做一些 log 处理，也可以做一些信息的统计，比如获取用户的请求 url 以及用户的 ip 地址等等

@Aspect
@Slf4j
@Component
public class LogAspectHandler {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());
    /**
     * 定义一个切面，拦截com.itcodai.course09.controller包和子包下的所有方法
     */
    @Pointcut("execution(* com.example.lyc.springboot.demo..*.*(..))")
    public void pointCut() {}

    /**
     * 在上面定义的切面方法之前执行该方法
     * @param joinPoint jointPoint
     */
    @Before("pointCut()")
    public void doBefore(JoinPoint joinPoint) {
        log.info("====doBefore方法进入了====");
        // 获取签名
        Signature signature = joinPoint.getSignature();
        // 获取切入的包名
        String declaringTypeName = signature.getDeclaringTypeName();
        // 获取即将执行的方法名
        String funcName = signature.getName();
        log.info("即将执行方法为: {}，属于{}包", funcName, declaringTypeName);

        // 也可以用来记录一些信息，比如获取请求的url和ip
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        if (attributes != null) {
            HttpServletRequest request = attributes.getRequest();
            // 获取请求url
            String url = request.getRequestURL().toString();
            // 获取请求ip
            String ip = request.getRemoteAddr();
            log.info("用户请求的url为：{}，ip地址为：{}", url, ip);
        } else {
            log.info("Not in a request context");
        }
    }

}

@After 注解

指定的方法在切面切入目标方法之后执行

也可以做一些完成某方法之后的 log 处理

   /**
   * 在上面定义的切面方法之后执行该方法
   * @param joinPoint jointPoint
   */
  @After("pointCut()")
  public void doAfter(JoinPoint joinPoint) {
          log.info("====doAfter方法进入了====");
          Signature signature = joinPoint.getSignature();
          String method = signature.getName();
          log.info("方法{}已经执行完", method);
          }

@AfterReturning 注解

用来捕获切入方法执行完之后的返回值，对返回值进行业务逻辑上的增强处理

[需要注意的是] 在 @AfterReturning注解中，属性 returning 的值必须要和参数保持一致，否则会检测不到。该方法中的第二个入参就是被切方法的返回值，在 doAfterReturning 方法中可以对返回值进行增强，可以根据业务需要做相应的封装。

    /**
     * 在上面定义的切面方法返回后执行该方法，可以捕获返回对象或者对返回对象进行增强
     * @param joinPoint joinPoint
     * @param result result
     */
    @AfterReturning(pointcut = "pointCut()", returning = "result")
    public void doAfterReturning(JoinPoint joinPoint, Object result) {

        Signature signature = joinPoint.getSignature();
        String classMethod = signature.getName();
        log.info("方法{}执行完毕，返回参数为：{}", classMethod, result);
        // 实际项目中可以根据业务做具体的返回值增强
        log.info("对返回参数进行业务上的增强：{}", result + "增强版");
    }

@AfterThrowing 注解

当被切方法执行时抛出异常时，会进入 @AfterThrowing 注解的方法中执行，在该方法中可以做一些异常的处理逻辑。

要注意的是 throwing 属性的值必须要和参数一致，否则会报错。该方法中的第二个入参即为抛出的异常。

/**
     * 在上面定义的切面方法执行抛异常时，执行该方法
     * @param joinPoint jointPoint
     * @param ex ex
     */
    @AfterThrowing(pointcut = "pointCut()", throwing = "ex")
    public void afterThrowing(JoinPoint joinPoint, Throwable ex) {
        Signature signature = joinPoint.getSignature();
        String method = signature.getName();
        // 处理异常的逻辑
        log.info("执行方法{}出错，异常为：{}", method, ex);
    }

annotation() 方式是针对某个注解来定义切面，比如我们对具有@GetMapping注解的方法做切面，可以如下定义切面：

@Pointcut("@annotation(org.springframework.web.bind.annotation.GetMapping)")
public void annotationCut() {}

静态资源

Spring Boot 的默认静态目录为 resources/static

配置静态资源路径

第一种方式：

在application.yml 文件中添加配置

src/main/resources/application-dev.yml

图片

spring:
  resources:
    static-locations: [classpath:/static/]

第二种方式：

在代码中配置

需鉴权（登录后请求头带上token才能访问）

com/cows/config/MvcConfig.java

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class MvcConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/files/**")
                .addResourceLocations("file:/absolute/path/to/your/directory/");
    }
}

无需鉴权

com/cows/config/SecurityConfig.java

@Configuration
@EnableWebSecurity
public class SecurityConfig {

    @Autowired
    private DataSource dataSource;

    @Bean
    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
        http
            .addFilterBefore(new JwtAuthenticationFilter(), UsernamePasswordAuthenticationFilter.class)// 添加JWT过滤器
            .authorizeRequests(authorize -> authorize
                .requestMatchers("/test.png","/v1/getLatestImage").permitAll()// 允许未认证访问
                .anyRequest().authenticated()
            )

接口

com/cows/controller/ImageController.java

配置多媒体音频文件

代码中

com/cows/config/MvcConfig.java

@Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
  registry.addResourceHandler("/files/**")
  .addResourceLocations("file:./upload/");
  registry.addResourceHandler("/mp3/**")
  .addResourceLocations("file:/src/main/resource/media/");
}

图片+音频

src/main/resources/application-dev.yml

spring:
  #  配置静态资源路径
  resources:
    static-locations:
      - classpath:/static/
      - classpath:/media/

配置pom.xml

 <resources>
        <resource>
            <directory>src/main/resources</directory>
        </resource>
        <resource>
            <directory>src/main/resources/media</directory>
        </resource>
    </resources>

如果你正在使用Spring Boot的内置Tomcat服务器，那么你可能需要将src/main/resources/media目录添加到你的项目的资源路径中。你可以在你的pom.xml文件中添加以下内容：

音频在线可播放

import org.springframework.http.MediaType;
import org.springframework.http.HttpHeaders;

@GetMapping("/media/{filename:.+}")
public ResponseEntity<Resource> serveFile(@PathVariable String filename) {

    Resource file = new ClassPathResource("src/main/resources/media/" + filename);
    try {
        file.getInputStream(); // check if file exists

        // Set the content type to audio/mpeg (for .mp3 files)
        // Adjust this to match the type of audio file you are serving (e.g., audio/ogg for .ogg files)
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.parseMediaType("audio/mpeg"));
        headers.add(HttpHeaders.CONTENT_DISPOSITION, "inline; filename=\"" + file.getFilename() + "\"");

        return ResponseEntity.ok().headers(headers).body(file);
    } catch (IOException e) {
        log.error("File not found: {}", filename, e);
        return ResponseEntity.notFound().build();
    }
}

在这个示例中，我们设置了 Content-Type 头为 audio/mpeg，这是 .mp3 文件的 MIME 类型。

你需要根据你的音频文件的实际类型来调整这个值。

我们还设置了 Content-Disposition 头为 inline，这意味着浏览器应尝试在页面上直接播放音频，而不是下载文件。

音频下载

如果你想让音频文件被下载而不是在线播放，你可以将 Content-Disposition 头的值从 inline 改为 attachment。

这将提示浏览器下载文件而不是尝试在页面上播放它。

import org.springframework.http.MediaType;
import org.springframework.http.HttpHeaders;

@GetMapping("/media/{filename:.+}")
public ResponseEntity<Resource> serveFile(@PathVariable String filename) {

    Resource file = new ClassPathResource("src/main/resources/media/" + filename);
    try {
        file.getInputStream(); // check if file exists

        // Set the content type to audio/mpeg (for .mp3 files)
        // Adjust this to match the type of audio file you are serving (e.g., audio/ogg for .ogg files)
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.parseMediaType("audio/mpeg"));
        headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + file.getFilename() + "\"");

        return ResponseEntity.ok().headers(headers).body(file);
    } catch (IOException e) {
        log.error("File not found: {}", filename, e);
        return ResponseEntity.notFound().build();
    }
}

事务

UserMapper.xml

UserServiceImpl.java

SQL异常不能被识别回滚

SpringBoot 默认的事务规则是遇到 运行异常（RuntimeException） 和）程序错误（Error） 才会回滚。比如抛出的 RuntimeException 就没有问题，但是抛出 SQLException 就无法回滚了。针对非运行时异常，如果要进行事务回滚的话，可以在 @Transactional 注解中使用 rollbackFor 属性来指定异常，比如 @Transactional(rollbackFor = Exception.class)，这样就没有问题了，所以在实际项目中，一定要指定异常。

异常被 ”吃“ 掉 ,异常怎么会被吃掉呢？

还是回归到现实项目中去，我们在处理异常时，有两种方式： 要么抛出去，让上一层来捕获处理； 要么把异常 try catch 掉，在异常出现的地方给处理掉。 就因为有这中 try…catch，所以导致异常被 ”吃“ 掉，事务无法回滚。

那这种怎么解决呢？ 直接往上抛，给上一层来处理即可，千万不要在事务中把异常自己 ”吃“ 掉。

事务范围这个东西比上面两个坑埋的更深！

举个实际的场景，比如：一个数据库中，针对某个用户，只有一条记录，下一个插入动作过来，会先判断该数据库中有没有相同的用户，如果有就不插入，就更新，没有才插入，所以理论上，数据库中永远就一条同一用户信息，不会出现同一数据库中插入了两条相同用户的信息。但是在压测时，就会出现上面的问题，数据库中确实有两条同一用户的信息，分析其原因，在于事务的范围和锁的范围问题。

那这种怎么解决呢？

根本原因：也就是说，在加锁的那部分代码执行完之后，锁释放掉了，但是事务还没结束，此时另一个线程进来了，事务没结束的话，第二个线程进来时，数据库的状态和第一个线程刚进来是一样的。即由于mysql Innodb引擎的默认隔离级别是可重复读（在同一个事务里，SELECT的结果是事务开始时时间点的状态），线程二事务开始的时候，线程一还没提交完成，导致读取的数据还没更新。第二个线程也做了插入动作，导致了脏数据。

这个问题可以避免，第一，把事务去掉即可（不推荐）；第二，在调用该 service 的地方加锁，保证锁的范围比事务的范围大即可。

如何控制事务范围和锁范围？

在Spring Boot中，事务的范围通常由@Transactional注解的方法定义。

当你在一个方法上使用@Transactional注解，Spring会在该方法开始时启动一个新的事务，并在方法结束时提交事务。

如果方法抛出了未捕获的异常，Spring会回滚事务,这就是事务的范围。

监听器

com/example/lyc/springboot/demo/listener

监听器 --> 监听事件

（一）应用监听

1.监听Servlet上下文对象

略

2.监听HTTP会话 Session对象

监听器还有一个比较常用的地方就是用来监听 session 对象，来获取在线用户数量，现在有很多开发者都有自己的网站，监听 session 来获取当前在下用户数量是个很常见的使用场景。

（1）MyHttpSessionListener.java

package com.example.lyc.springboot.demo.listener;

import jakarta.servlet.http.HttpSessionEvent;
import jakarta.servlet.http.HttpSessionListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

/**
 * 使用HttpSessionListener统计在线用户数的监听器
 * @author liyinchi
 * @date 2023/12/13
 */
@Component
public class MyHttpSessionListener implements HttpSessionListener {

    private static final Logger logger = LoggerFactory.getLogger(MyHttpSessionListener.class);

    /**
     * 记录在线的用户数量
     */
    public Integer count = 0;

    @Override
    public synchronized void sessionCreated(HttpSessionEvent httpSessionEvent) {
        logger.info("新用户上线了");
        count++;
        httpSessionEvent.getSession().getServletContext().setAttribute("count", count);
    }

    @Override
    public synchronized void sessionDestroyed(HttpSessionEvent httpSessionEvent) {
        logger.info("用户下线了");
        count--;
        httpSessionEvent.getSession().getServletContext().setAttribute("count", count);
    }
}

可以看出，首先该监听器需要实现 HttpSessionListener 接口，然后重写 sessionCreated 和 sessionDestroyed 方法，在 sessionCreated 方法中传递一个 HttpSessionEvent 对象，然后将当前 session 中的用户数量加1，sessionDestroyed 方法刚好相反。

写一个 Controller 来测试一下

（2）TestController.java

@RestController
@RequestMapping("/listener")
public class onlineController {

  @GetMapping("/total2")
  public String getTotalUser(HttpServletRequest request, HttpServletResponse response) {
    Cookie cookie;
    try {
      // 把sessionId记录在浏览器中
      cookie = new Cookie("JSESSIONID", URLEncoder.encode(request.getSession().getId(), "utf-8"));
      cookie.setPath("/");
      //设置cookie有效期为2天，设置长一点
      cookie.setMaxAge( 48*60 * 60);
      response.addCookie(cookie);
    } catch (UnsupportedEncodingException e) {
      e.printStackTrace();
    }
    Integer count = (Integer) request.getSession().getServletContext().getAttribute("count");
    return "当前在线人数：" + count;
  }
}

该处理逻辑是让服务器记得原来那个session

即把原来的sessionId记录在浏览器中，下次再打开时，把这个 sessionId 传过去，这样服务器就不会重新再创建了。

重启一下服务器，在浏览器中再次测试一下，即可避免上面的问题。

3.监听客户端请求Servlet Request对象

使用监听器获取用户的访问信息

（1）ServletRequestListener

实现 ServletRequestListener接口，然后通过 request对象获取一些信息。

package com.example.lyc.springboot.demo.listener;

import jakarta.servlet.ServletRequestEvent;
import jakarta.servlet.ServletRequestListener;
import jakarta.servlet.http.HttpServletRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

/**
 * 使用ServletRequestListener获取访问信息
 * @author liyinchi
 * @date 2023/12/13
 */
@Component
public class MyServletRequestListener implements ServletRequestListener {

    private static final Logger logger = LoggerFactory.getLogger(MyServletRequestListener.class);

    @Override
    public void requestInitialized(ServletRequestEvent servletRequestEvent) {
        HttpServletRequest request = (HttpServletRequest) servletRequestEvent.getServletRequest();
        logger.info("session id为：{}", request.getRequestedSessionId());
        logger.info("request url为：{}", request.getRequestURL());

        request.setAttribute("name", "测试自定义事件监听器");
    }

    @Override
    public void requestDestroyed(ServletRequestEvent servletRequestEvent) {

        logger.info("request end");
        HttpServletRequest request = (HttpServletRequest) servletRequestEvent.getServletRequest();
        logger.info("request域中保存的name值为：{}", request.getAttribute("name"));

    }

}

（2）UserController

接下来写一个 Controller 测试

@GetMapping("/request")
public String getRequestInfo(HttpServletRequest request) {
    System.out.println("requestListener中的初始化的name数据：" + request.getAttribute("name"));
    return "success";
}

（二）自定义监听

定义事件

自定义事件

（1）MyEvent.java

com/cows/event/MyEvent.java

/**
 * 自定义事件
 * @author liyinchi
 * @date 2023/12/13
 */
@Getter
@Setter
public class MyEvent extends ApplicationEvent {

  private User user;

  public MyEvent(Object source, User user) {
    super(source);
    this.user = user;
  }

  // 省去get、set方法
}

自定义一个监听器

监听上面定义的 MyEvent 事件，自定义监听器需要实现 ApplicationListener 接口即可。重写 onApplicationEvent 方法)

（2）MyEventListener.java

com/cows/event/MyEventListener.java

/**
 * 自定义监听器，监听MyEvent事件
 * @author liyinchi
 * @date 2023/12/13
 */
@Slf4j
@Component
public class MyEventListener implements ApplicationListener<MyEvent> {
  @Override
  public void onApplicationEvent(MyEvent myEvent) {
    // 把事件中的信息获取到
    User user = myEvent.getUser();
    // 处理事件，实际项目中可以通知别的微服务或者处理其他逻辑等等
    log.info("MyEventListener", "用户名：" + user.getUserName());
    log.info("MyEventListener", "密码：" + user.getPassword());

  }
}

发布事件

（3）UserServiceImple

/com/cows/service/impl/UserServiceImple.java

 @Service
public class UserServiceImpl implements UserService {

    /**
     * 发布事件
     * @return
     */
    public User getUser2() {
        User user = new User(1, "测试", "123456", 0);
        // 发布事件
        MyEvent event = new MyEvent(this, user);
        applicationContext.publishEvent(event);
        return user;
    }
}

测试接口

UserController

最后，在 Controller 中写一个接口来测试一下：

/com/cows/controller/UserController.java

@GetMapping("/request")
public String getRequestInfo(HttpServletRequest request) {
    log.info("requestListener中的初始化的name数据：" + request.getAttribute("name"));
    return "success";
}

拦截器

com/cows/controller/Interceptor

拦截器的原理很简单，是AOP的一种实现，专门拦截对动态资源的后台请求，即拦截对控制层的请求。

使用场景比较多的是判断用户是否有权限请求后台，更拔高一层的使用场景也有，比如拦截器可以结合 websocket 一起使用，用来拦截 websocket 请求，然后做相应的处理等等。 拦截器不会拦截静态资源，Spring Boot 的默认静态目录为 resources/static，该目录下的静态页面、js、css、图片等等，不会被拦截（也要看如何实现，有些情况也会拦截，我在下文会指出）。

在 MVC（Model-View-Controller）架构中，拦截器（Interceptor）通常属于控制器（Controller）层。

它们主要用于处理跨越多个请求或控制器的行为，例如：日志记录、身份验证、授权以及性能监控等。

在 Spring 框架中，拦截器可以注册为 Spring Bean 并配置为拦截特定的 URL 模式，以在请求被实际的控制器处理之前或之后执行特定的操作。

使用拦截器很简单，只需要两步即可：①定义拦截器和②配置拦截器

（1）定义拦截器

com/cows/controller/Interceptor/MyInterceptor.java

@Configuration
public class MyInterceptorConfig extends WebMvcConfigurationSupport {

    /**
     * 用来指定静态资源不被拦截，否则继承WebMvcConfigurationSupport这种方式会导致静态资源无法直接访问
     * @param registry
     */
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
        super.addResourceHandlers(registry);
    }
}

（2）配置拦截器

com/cows/config/MyInterceptorConfig.java

@Configuration
public class MyInterceptorConfig extends WebMvcConfigurationSupport {

  /**
   * 用来指定静态资源不被拦截，否则继承WebMvcConfigurationSupport这种方式会导致静态资源无法直接访问
   * @param registry
   */
  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
  }

  @Override
  protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
    super.addResourceHandlers(registry);
  }
}

测试拦截器

com/cows/controller/TestController.java

@Controller
@RequestMapping("/interceptor")
public class InterceptorController {
    @RequestMapping("/test")
    public String test() {
        return "hello";
    }
}

Mysql

Docker安装mysql

（1）拉镜像

docker pull mysql:5.7

（2）启动容器

docker run -itd --name mysql-test -p 3306:3306 -e MYSQL_ROOT_PASSWORD=lyc123456 mysql

Redis

阿里云云原生redis

Docker安装redis

（1）拉镜像

docker pull  redis

（2）启动容器

docker run --name my-redis -d -p 6379:6379 redis redis-server --protected-mode yes --requirepass 123456

配置redis

src/main/resources/application.yml

#redis相关配置
redis:
  database: 1 # 
  # 配置redis的主机地址，需要修改成自己的
  host: 127.0.0.1
  port: 6380   # 默认是6379
  password: 123456
  timeout: 10000
  jedis:
    pool:
      # 连接池中的最大空闲连接，默认值也是8。
      max-idle: 500
      # 连接池中的最小空闲连接，默认值也是0。
      min-idle: 50
      # 如果赋值为-1，则表示不限制；如果pool已经分配了maxActive个jedis实例，则此时pool的状态为exhausted(耗尽)
      max-active: 1000
      # 等待可用连接的最大时间，单位毫秒，默认值为-1，表示永不超时。如果超过等待时间，则直接抛出JedisConnectionException
      max-wait: 2000

docker redis 查看ip和端口

docker inspect my-redis

如果Redis容器运行在本地，并且映射到了6379端口，可以使用以下命令来测试连接

redis-cli -h 127.0.0.1 -p 6379

nc -zv 127.0.0.1 6380

常用redis方法

字符串

# 设置值
set key value
# 获取值
get key
# 删除值
del key

分布式锁

分布式事务

分布式ID

分布式缓存

shiro

activeMQ

JMS 即 Java 消息服务（Java Message Service）应用程序接口，是一个Java平台中关于面向消息中间件（MOM）的 API，用于在两个应用程序之间，或分布式系统中发送消息，进行异步通信。 Java 消息服务是一个与具体平台无关的 API，绝大多数 MOM 提供商都对 JMS 提供支持。

JMS 只是接口，不同的提供商或者开源组织对其有不同的实现，ActiveMQ 就是其中之一，它支持JMS，是 Apache 推出的。JMS 中有几个对象模型：

连接工厂：ConnectionFactory
JMS连接：Connection
JMS会话：Session
JMS目的：Destination
JMS生产者：Producer
JMS消费者：Consumer
JMS消息两种类型：点对点 和 发布/订阅。

可以看出 JMS 实际上和 JDBC 有点类似，JDBC 是可以用来访问许多不同关系数据库的 API，而 JMS 则提供同样与厂商无关的访问方法，以访问消息收发服务。本项目主要使用 ActiveMQ，其他像是rocketMQ，kafka等。

生产者（Producer）：消息的发送者，负责创建消息，并将其发送到消息队列中。
消费者（Consumer）：消息的接收者，负责从消息队列中获取消息。
消息队列（Message Queue）：用来存储消息，消息队列是 JMS 的核心，生产者将消息发送到消息队列，消费者从消息队列中获取消息。
连接工厂（Connection Factory）：用来创建生产者与消费者与消息队列之间的连接。
连接（Connection）：生产者与消费者与消息队列之间的一个TCP连接。
会话（Session）：生产者与消费者与消息队列之间的一个连接，可以创建消息，发送消息，接收消息。
目的地（Destination）：消息队列的名称，或者队列或主题。
消息（Message）：消息队列中传输的数据，由消息头和消息体组成。
消息头（Message Header）：消息的属性，包括消息的优先级，消息的创建时间，消息的过期时间，消息的重复次数
消息体（Message Body）：消息的内容。
消息属性（Message Properties）：消息的属性，包括消息的优先级，消息的创建时间，消息的过期时间，消息的重复次数。
消息类型（Message Type）：消息的类型，包括队列和主题。
消息模式（Message Pattern）：消息的模式，包括点对点和发布/订阅。
消息驱动者（Message Driven）：消息驱动者，消息生产者，消息消费者。

安装ActiveMQ

docker 安装

docker pull rmohr/activemq

docker run -d --name activemq -p 61616:61616 -p 8161:8161 rmohr/activemq

将容器的61616端口（ActiveMQ的默认端口）和8161端口（ActiveMQ的管理界面端口）映射到你的主机的相应端口。

在浏览器中访问http://localhost:8161 来查看ActiveMQ的管理界面。

http://localhost:8161/admin/

默认的用户名和密码都是admin。

生产者

MsgProducer.java

com/example/lyc/springboot/demo/producer/MsgProducer.java

@Service
public class MsgProducer {

    @Resource
    private JmsMessagingTemplate jmsMessagingTemplate;

    public void sendMessage(Destination destination, String msg) {
        jmsMessagingTemplate.convertAndSend(destination, msg);
    }
}

消费者

QueueConsumer.java

com/example/lyc/springboot/demo/consumer/QueueConsumer.java

@Slf4j
@Service
public class QueueConsumer {

    /**
     * 接收点对点消息
     * @param msg
     */
    @JmsListener(destination = ActiveMqConfig.QUEUE_NAME)//
    public void receiveQueueMsg(String msg) {
        log.info("消费者 收到的消息为：" + msg);
    }
}

Controller

ActiveMqController.java

com/example/lyc/springboot/demo/controller/ActiveMqController.java

@Slf4j
@RestController
@RequestMapping("/activemq")
public class ActiveMqController {
    private static final Logger logger = LoggerFactory.getLogger(ActiveMqController.class);
    @Resource
    private MsgProducer producer;
    @Resource
    private Destination queue;

    @GetMapping("/send/queue")
    public String sendQueueMessage() {
        logger.info("===开始发送点对点消息===");
        producer.sendMessage(queue, "Queue: hello activemq!");
        log.info("===生产者 发送点对点消息===");
        return "success";
    }
}

WebSocket

1.WebSocketConfig.java

com/cows/config/WebSocketConfig.java

2.MyWebSocketHandler.java

com/cows/handler/MyWebSocketHandler.java

3.测试webSocket

TestWebSocket.html

常见问题

1.项目端口被占用

mac 查看进程占用

lsof -i:8088
kill -s 9 进程号

接口返回一个html页面

src/main/resources/templates/TestPage.html

package com.example.lyc.springboot.demo.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

@Controller
public class IoTController {

    @GetMapping("/page")
    public String getPage() {
        return "TestPage";
    }

}

接口存储某个值，用于其他接口来获取这个isGo的值

用Spring的@SessionAttribute或者@SessionAttributes来在多个请求之间共享数据。

（1）首先，你需要在你的控制器类上添加@SessionAttributes注解，并指定你想要存储在session中的属性名称，

@Controller
@SessionAttributes("isGo")
public class IoTController {
    // ...
}

（2）然后，你可以在你的doAction方法中将isGo参数的值存储到session中：

@GetMapping("/action")
public String doAction(@RequestParam boolean isGo, Model model) {
    model.addAttribute("isGo", isGo);
    return "actionResult";
}

（3）最后，你可以在你的新接口中获取session中的isGo值：

@GetMapping("/getIsGo")
public String getIsGo(Model model) {
        Boolean isGo = (Boolean) model.getAttribute("isGo");
        // 在这里处理isGo值
        return "getIsGoResult";
        }

（4）使用JsonResult类来封装你的接口返回结果。

在IoTController类中，你需要将String类型的返回值改为JsonResult类型的返回值。然后，你可以使用JsonResult的构造函数来创建返回结果。这是修改后的IoTController类：

import api.commons.com.cows.JsonResult;
import org.springframework.web.bind.annotation.*;
import org.springframework.ui.Model;

@Controller
@RequestMapping("/v1")
@SessionAttributes("isGo")
public class IoTController {

  @GetMapping("/page")
  public String getPage() {
    return "TestPage";
  }

  @GetMapping("/action")
  public JsonResult<String> doAction(@RequestParam boolean isGo, Model model) {
    model.addAttribute("isGo", isGo);
    return new JsonResult<>("actionResult");
  }

  @GetMapping("/getIsGo")
  public JsonResult<Boolean> getIsGo(Model model) {
    Boolean isGo = (Boolean) model.getAttribute("isGo");
    return new JsonResult<>(isGo);
  }
}

数据库字段是下划线而实体类是驼峰形式

在 Java 实体类和数据库字段之间的映射中，确实常见的问题是命名风格的不一致。- 在 Java 中通常使用驼峰命名法（如 userId），而在数据库中则常用下划线命名法（如 user_id）。MyBatis 可以很好地处理这种命名风格的转换，但是需要确保配置正确。
在 MyBatis 中，默认情况下，它会尝试将驼峰命名自动转换为下划线命名。这意味着如果你的实体类字段是 userId，MyBatis 会在生成 SQL 时自动查找 user_id 字段。这通常是通过 MyBatis 的配置项 mapUnderscoreToCamelCase 来控制的，确保它被设置为 true（这通常是默认设置）。
确保 MyBatis 配置正确

在你的 MyBatis 配置文件中（通常是 mybatis-config.xml），你可以添加或确认以下设置：

<settings>
    <setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>

这个设置确保 MyBatis 在处理数据库列名和 Java 属性名时，会自动进行驼峰和下划线的转换。

检查 MyBatis 映射文件

在你的 OrderMapper.xml 文件中，确保 SQL 语句使用的是数据库的列名，例如：

<insert id="insertOrder" parameterType="com.cows.entity.Order">
  INSERT INTO Orders (user_id, total_price, status) VALUES (#{userId}, #{totalPrice}, #{status})
</insert>

在这里，#{userId}, #{totalPrice}, 和 #{status} 是 MyBatis 参数占位符，它们将自动映射到 Order 类的 userId, totalPrice, 和 status 属性。

配置typeHandler

src/main/resources/mybatis/mybatis-config.xml

<typeHandlers>
    <typeHandler handler="com.cows.handler.JsonTypeHandler" javaType="com.cows.entity.ProductsCarousels" jdbcType="VARCHAR"/>
</typeHandlers>

作用是将java对象转换为json，将json转换为java对象

如何在 Java 中使用 BigDecimal 类型与数据库中的 DECIMAL 类型相匹配？

在 Java 中使用 BigDecimal 类型与数据库中的 DECIMAL 类型相匹配是常见的做法，因为 BigDecimal 提供了精确的小数运算，非常适合处理金融数据。在 MyBatis 中，BigDecimal 类型可以直接映射到 SQL 的 DECIMAL 类型，因此这种类型的映射通常不会引起问题。

Java BigDecimal 对应于 SQL DECIMAL 是标准的映射，MyBatis 会自动处理这种类型转换。在 MyBatis 的结果映射中，resultType 或 resultMap 通常能够正确地处理 BigDecimal 与 DECIMAL 之间的转换。

（1）

private BigDecimal totalPrice

（2）数据库表

total_price DECIMAL(10, 2) NOT NULL,

Docker配置国内镜像源

第一步：新建或编辑daemon.json

vi /etc/docker/daemon.json

第二步：daemon.json中编辑如下

{
"registry-mirrors": ["http://hub-mirror.c.163.com","https://registry.docker-cn.com","https://docker.mirrors.ustc.edu.cn"]
}

第三步：重启docker

sudo systemctl daemon-reload
sudo systemctl restart docker

第四步：执行docker info查看是否修改成功

docker info

微信公众平台，微信授权登录报错{"errcode":40125,"errmsg":"invalid appsecret, rid: 6671ab61-0dd17ae3-718c1ccd"}

问题原因：appid和appsecret不匹配

参考：https://developers.weixUserin.qq.com/community/develop/doc/0000886514c7987cbf40d2b846b000?highLine=invalid%2520appsecret

Nginx反向代理

https://www.cnblogs.com/lujunan/p/12447275.html?tt_from=weixin&utm_source=weixin&utm_medium=toutiao_ios&utm_campaign=client_share&wxshare_count=1

（1）域名购买、备案（20天）、解析

（2）SSL证书申请购买

（2）修改Nginx.conf配置文件

配置域名和前端项目映射

http

  server{
          listen       80;
          server_name  localhost;
    
          location / {
              root   /usr/share/nginx/html/dist;
              index  index.html index.htm;
          }
  }

https

    server{
                    listen       443 ssl;
              server_name  localhost;
    
              ssl_certificate      /etc/nginx/ssl/1_localhost.cer;  # 证书文件
              ssl_certificate_key  /etc/nginx/ssl/2_localhost.key;  # 私钥文件
    
              ssl_session_cache    shared:SSL:1m;
              ssl_session_timeout  5m;
    }

前端项目

server {
    listen 9000;  # 监听 80 端口
    server_name 81.71.17.188;  # 服务器地址

    location / {
        root /home/dist;  # 指向你的 dist 文件夹
        try_files $uri $uri/ /index.html;  # 支持 Vue Router 的 HTML5 History 模式
    }

    error_page 404 /404.html;  # 自定义 404 页面
    location = /404.html {
        internal;
    }

    # 可选：配置跨域
    location /api/ {
        proxy_pass http://81.71.17.188:8088;  # 代理到后端服务
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

（4）重启Nginx

cd /usr/local/nginx/sbin/
./nginx -s reload
sudo nginx -s reload

查看Nginx进程

ps aux|grep nginx

返回内容类型不一致

从微信API获取用户信息时，返回的内容类型是 text/plain，而 RestTemplate 没有适当的 HttpMessageConverter 来处理这种类型，导致无法将响应转换为 WechatUser 类型的对象。

解决方法：

添加相应的 HttpMessageConverter 来处理 text/plain 类型的响应。
或者，修改微信API的返回内容类型为 application/json，以使 RestTemplate 可以正确处理响应。

要解决这个问题，你需要确保 RestTemplate 能够处理 text/plain 类型的响应，并能将其转换为所需的对象。这通常涉及到添加一个自定义的 HttpMessageConverter，它能够将 text/plain 类型的响应解析为 JSON，然后再将 JSON 转换为对象。

返回内容类型是统一在哪里定义的？比如有text、xml、json不同格式是不是要分开定义？

在 Spring Framework 中，返回内容类型通常是通过 HttpMessageConverter 接口的实现来定义的，这些转换器负责在 HTTP 请求和响应之间转换数据。每种数据格式（如 JSON, XML, 文本等）通常都有对应的转换器来处理。Spring 自动配置了一些默认的转换器，但你也可以自定义或添加新的转换器来支持更多的媒体类型。

默认的 HttpMessageConverter 实现 Spring 提供了以下一些默认的 HttpMessageConverter 实现：

ByteArrayHttpMessageConverter —— 处理字节流。
StringHttpMessageConverter —— 处理字符串。
MappingJackson2HttpMessageConverter —— 处理 JSON（使用 Jackson 库）。
MappingJackson2XmlHttpMessageConverter —— 处理 XML（使用 Jackson 的 XML 扩展）。
Jaxb2RootElementHttpMessageConverter —— 处理 XML（使用 JAXB）。

配置多种内容类型如果你需要处理不同的内容类型，你可以向 RestTemplate 的转换器列表中添加多个转换器。每个转换器可以设置支持的媒体类型。例如，如果你需要同时处理 JSON 和 XML 响应，你可以这样配置：

@Bean
public RestTemplate restTemplate() {
    RestTemplate restTemplate = new RestTemplate();

    // 获取默认的转换器列表
    List<HttpMessageConverter<?>> messageConverters = new ArrayList<>(restTemplate.getMessageConverters());

    // 配置JSON转换器
    MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter();
    jsonConverter.setSupportedMediaTypes(Arrays.asList(MediaType.APPLICATION_JSON, MediaType.TEXT_PLAIN));
    messageConverters.add(jsonConverter);

    // 配置XML转换器
    Jaxb2RootElementHttpMessageConverter xmlConverter = new Jaxb2RootElementHttpMessageConverter();
    xmlConverter.setSupportedMediaTypes(Arrays.asList(MediaType.APPLICATION_XML));
    messageConverters.add(xmlConverter);

    // 设置自定义的转换器列表
    restTemplate.setMessageConverters(messageConverters);

    return restTemplate;
}

在这个例子中，MappingJackson2HttpMessageConverter 被配置为处理 JSON 和纯文本（text/plain），而 Jaxb2RootElementHttpMessageConverter 被配置为处理 XML。这样，RestTemplate 就可以根据响应的 Content-Type 头部来选择合适的转换器进行数据转换。

总结

通过适当配置 HttpMessageConverter，你可以灵活地处理各种不同的内容类型。如果有特殊需求，例如处理非标准的媒体类型或自定义数据格式，你也可以实现自己的 HttpMessageConverter。

返回数据类型Thymeleaf模版、json

（1）使用 Thymeleaf 作为模板引擎

① 创建 Thymeleaf 模板文件在你的 Spring Boot 项目中，通常模板文件位于 src/main/resources/templates 目录下。

创建一个名为 userProfile.html 的文件：

<!-- src/main/resources/templates/userProfile.html -->
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>User Profile</title>
</head>
<body>
    <h1>User Profile</h1>
    <div>
        <p>Username: <span th:text="${user.userName}"></span></p>
        <p>WeChat OpenID: <span th:text="${user.wechatOpenId}"></span></p>
        <!-- 添加更多用户信息 -->
    </div>
</body>
</html>

② 修改控制器方法

确保你的控制器方法返回的是视图名称，并且向模型中添加了必要的数据。

@GetMapping("/userProfile")
public String userProfile(Model model) {
    // 从数据库或其他地方获取用户信息
    User user = userService.getUserById(1); // 示例方法，实际情况可能需要根据用户ID或OpenID查询
    model.addAttribute("user", user);
    return "userProfile";
}

（2）使用json

// H5微信回调
    @GetMapping("/wechat/callback")
    public ResponseEntity<?> wechatCallback(@RequestParam String code, @RequestParam String state) {
        // 调用服务获取access_token
        WechatService.AccessTokenResponse tokenResponse = wechatService.getAccessToken(code, "authorization_code");
        
        // 当方法返回类型是json时，可以直接返回
        if (tokenResponse == null || tokenResponse.getAccessToken() == null) {
            return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("Failed to retrieve access token");
        }

        String accessToken = tokenResponse.getAccessToken();
        String openid = tokenResponse.getOpenid();
        System.out.println("AccessToken: " + accessToken);
        System.out.println("OpenID: " + openid);
        
        // 使用access_token获取用户信息
        WechatUser wechatUser = wechatService.getUserInfo(accessToken, openid);
        
        // 当方法返回类型是json时，可以直接返回
        if (wechatUser == null) {
            return ResponseEntity.status(HttpStatus.NOT_FOUND).body("User not found");
        }
        // 根据业务逻辑处理用户信息，例如创建用户、生成JWT等
        wechatUser.setOpenId(openid); // 确保设置了openid
        User user = userService.loginOrCreateWechatUser(wechatUser);// 检查或创建用户

        // 返回用户信息的 JSON
        return ResponseEntity.ok(user);
    }

Files

README.md

Latest commit

History

README.md

File metadata and controls

一个公司企业官网后端项目

版本

技术栈

项目结构

项目结构

项目依赖

项目配置

JDK

启动

部署

项目切换产线环境

配置前端跨域

允许跨域

允许跨域

配置具体跨域地址

数据库地址和端口

配置

引用

打jar包

运行jar包

无窗口化运行

手动测试

容器化部署

创建上传文件夹

数据库

表

restfull API

登录接口（JWT）

GET

分页查询

POST

PUT

DELETE

配置跨域 CORS

H5微信授权登录

微信公众号配置

接口请求顺序

WechatService.java

WechatUser.java

loginController.java

AppConfig.java

application-dev.yml

JSSDK

网页扫码登录

swagger接口文档

全局异常处理

业务异常（枚举异常）

参数缺失

处理空指针异常

所有不可知的异常(不推荐)

处理数组越界异常

一劳永逸异常

全局返回结果处理

处理成功返回结果

处理失败返回结果

统一日志处理

文件上传

生成工具

快速实现实体类、mapper、数据库表字段

切面

日志切面

静态资源

配置静态资源路径

配置多媒体音频文件

音频在线可播放

音频下载

事务

UserMapper.xml

UserServiceImpl.java

监听器

（一）应用监听

1.监听Servlet上下文对象

2.监听HTTP会话 Session对象

3.监听客户端请求Servlet Request对象