当前位置： 首页 > news >正文

0x05 部门功能开发日志技术

news 来源：原创 2025/5/19 1:01:25

准备工作

开发规范

采用restful风格：representational state transfer，表述性状态转换，是一种软件架构风格

在这里插入图片描述

1740843204118.png

REST是风格，是约定方式，约定不是规定，可以打破

描述功能模块通常使用复数形式加s（如users），表示此类资源，而非单个资源

后端单元测试

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

前后端并行开发，先开发完成的工程师可以直接测试，现在市面上经常使用的工具有两种postman和Apifox

Apifox功能更强大

工程搭建

  1. 创建SpringBoot工程，并引入web开发起步依赖、mybatis、mysql驱动、lombok
  2. 创建数据库表dept，并在application.yml中配置数据库的基本信息
  3. 准备基础代码结构，并引入实体类Dept及统一的响应结果封装类Result

正式开发

查询部门

在这里插入图片描述

controller

@RestController
public class DeptController {
    @Autowired
    private DeptService deptService;

    //@RequestMapping(value = "/depth", method = RequestMethod.GET)
    @GetMapping("/depts")
    public Result list() {
       List<Dept> deptList = deptService.findAll();
       return Result.success(deptList);
    }
}

@RestController=@Controller+@ResponseBody

@Controller用于标记一个类为控制器，负责处理HTTP请求，执行业务逻辑，并返回视图或数据

@ResponseBody直接将Controller方法返回的值写入到HTTP响应体中，Spring框架默认情况会将返回值转化为JSON格式

Service

service接口

public interface DeptService {
    List<Dept> findAll();
}

service实现类

@Service
public class DeptServiceImpl implements DeptService {
    @Autowired
    DeptMapper deptMapper;
    @Override
    public List<Dept> findAll() {
        return deptMapper.findAll();
    }
}

Mapper

@Mapper
public interface DeptMapper {
    @Select("select id, name, create_time, update_time from dept order by  dept.update_time desc ;")
    List<Dept> findAll();
}

接口测试

用apifox对http://localhost:8080/depts发送get请求

1740876520636.png

整体流程

在这里插入图片描述

遗留问题

从apifox测试返回的数据可以看到creatTime和updateTime这两个数据没有正确返回，这里设计一个数据封装问题

如果实体类属性名和数据库表查询返回的字段名一致，mybatis会自动封装

如果实体类属性名和数据库表查询返回的字段名不一致，不能自动封装

1740877249908.png

1740877280368.png

解决方法

  1. 手动结果映射：通过@Results及@Result

修改Mapper中DeptMapper的代码

@Mapper
public interface DeptMapper {
    @Results({
            @Result(column = "create_time", property = "createTime"),
            @Result(column = "update_time", property = "updateTime"),
    })
    @Select("select id, name, create_time, update_time from dept order by  dept.update_time desc ;")
    List<Dept> findAll();
}
  1. 起别名，在sql语句中给属性取别名
@Mapper
public interface DeptMapper {

    @Select("select id, name, create_time createTime, update_time updateTime from dept order by  dept.update_time desc ;")
    List<Dept> findAll();
}
  1. 开启驼峰命名映射：如果字段名与属性名符合驼峰命名规则，mybatis会自动通过驼峰命名规则映射
mybatis:
  configuration:
    map-underscore-to-camel-case: true

这就要求数据库中属性的命名是以下划线分割,实体类的属性需要时驼峰命名，xxx_abc -> xxxAbc

前后端联调

可以看到前端工程请求服务器的地址为http://localhost:90/api/depts，并没有直接访问tomcat服务器，但是仍然从tomcat服务器获得了需要的数据，这是通过nginx的反向代理实现的

在这里插入图片描述

反向代理是一种网络架构，通过代理服务器为后端服务器做代理，客户端的请求直接请求代理服务器，然后转发给后端服务器，优势如下：

在这里插入图片描述

nginx的配置

在这里插入图片描述

删除部门

接收请求参数：DELETE /depts?id=8

在这里插入图片描述

controller层代码，有三种方法，推荐的是用下面这种，需要注意接受参数的变量名需要和前端发来请求的参数名一致

 /*
    删除部门
     */
    @DeleteMapping("/depts")
    public Result delete(Integer id) {
        System.out.println(id);
        return Result.success();
    }

service层代码

@Override
public void deleteById(Integer id) {
    deptMapper.deleteById(id);
}

mapper层代码

@Delete("delete from dept where id=#{id}")
void deleteById(Integer id);

controller调用service，并将id这个参数向下传递，service调用mapper，同时将参数向下传递，mapper将id作为sql语句执行的条件，执行相应的sql语句。

mapper层使用了#{}作为占位符生成预编译的sql语句，预编译的sql代码为delete from dept where id=？，其中的？最后被替换为service层传递过来的参数id

新增部门

添加部门采用的请求方式是POST请求

这个参数传递并不是像删除部门那样从url中传递过来的，而是在请求体中传递过来的

在这里插入图片描述

JSON格式的参数，通常会使用一个实体对象进行接收

接收的规则：JSON数据的键名与方法形参对象的属性名相同，并需要使用**@ResponseBody**注解标识。

1740905527595.png

controller层代码

    /*
    新增部门
     */
    @PostMapping("/depts")
    public Result add(@RequestBody Dept dept) {
        deptService.add(dept);
        return Result.success();
    }

service层代码

    @Override
    public void add(Dept dept) {
        // 1. 补全基础属性 -create-time、update-time
        dept.setCreateTime(LocalDateTime.now());
        dept.setUpdateTime(LocalDateTime.now());
        // 2. 调用Mapper接口方法插入数据
        deptMapper.insert(dept);
    }

mapper层代码

    @Insert("insert into dept (name, create_time, update_time) values (#{name}, #{createTime}, #{updateTime});")
    void insert(Dept dept);

在这里插入图片描述

修改部门

查询回显

查询回显也就是根据id进行查询

在这里插入图片描述

controller层主要是接收前端传过来的路径参数，通过url直接传递参数，使用{…}来标识该路径 参数，需要使用**@PathVariable**获取路径参数

/*
根据id查询部门
 */
@GetMapping("/depts/{id}")
public Result getInfo(@PathVariable("id") Integer deptid) {
    System.out.println(deptid);
    return Result.success();
}

简化写法，路径参数的名称与方法的形参名一致的话就可以将**@PathVariable注解的value属性值省略，只写一个@PathVariable**即可

简化后的代码

    /*
    根据id查询部门
     */
    @GetMapping("/depts/{id}")
    public Result getInfo(@PathVariable Integer id) {
        System.out.println(id);
        return Result.success();
    }

1740906611139.png

service层代码：直接返回调用Mapper层的结果

   @Override
   public Dept getById(Integer id) {

       return deptMapper.getById(id);
   }

mapper层：根据service层传来的参数执行对应的sql语句

    @Select("select id, name, create_time, update_time from dept where id=#{id}")
    Dept getById(Integer id);

在这里插入图片描述

修改数据

在这里插入图片描述

controller层代码

    /*
    修改部门
     */
    @PutMapping("/depts")
    public Result update(@RequestBody Dept dept) {
        System.out.println(dept);
        deptService.update(dept);
        return Result.success();
    }

service层代码：补全基础属性，这里就是更新时间

    @Override
    public void update(Dept dept) {
        dept.setUpdateTime(LocalDateTime.now());
        deptMapper.update(dept);
    }

mapper层代码：通过mybatis执行sql语句

    @Update("update dept set name = #{name},update_time=#{updateTime} where id = #{id}")
    void update(Dept dept);

代码改进

对增删改查部分请求的路径都是从depts开始，我们可以将这部分公共路径从方法前面提取到整个类的前面，后面不同的部分仍需要保留

在这里插入图片描述

@RequestMapping注解可以加在类和方法上，一个完整的请求路径=类上的请求路径+方法上的请求路径

日志技术

入门

程序中的日志，是用来记录应用程熙的运行信息、状态信息、错误信息等的

现在项目中经常使用的是Logback技术来记录日志，但他是比较底层，Slf4j是对其的封装

引入logback.xml配置文件，放到src/main/resource目录下

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度  %msg：日志消息，%n是换行符 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%n</pattern>
        </encoder>
    </appender>

    <!-- 日志输出级别 -->
    <root level="ALL">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

定义日志记录对象Logger，调用方法记录日志

public class LogTest {
    
    //定义日志记录对象
    private static final Logger log = LoggerFactory.getLogger(LogTest.class);

    @Test
    public void testLog(){
        log.debug("开始计算...");
        int sum = 0;
        int[] nums = {1, 5, 3, 2, 1, 4, 5, 4, 6, 7, 4, 34, 2, 23};
        for (int i = 0; i < nums.length; i++) {
            sum += nums[i];
        }
        log.info("计算结果为: "+sum);
        log.debug("结束计算...");
    }

}

配置文件

logback.xml配置文件时对Logback日志框架输出的日志进行控制的，可以配置日志输出的格式、位置、日志开关，常用的两种输出日志的位置：控制台、系统文件

控制具体要输出那些级别的日志，以及具体要输出的位置**（控制台 or 文件）**

    <!-- 日志输出级别 -->
    <root level="ALL">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>

输出日志到控制台的格式

    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d 表示日期，%thread 表示线程名，%-5level表示级别从左显示5个字符宽度，%logger显示日志记录器的名称， %msg表示日志消息，%n表示换行符 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%n</pattern>
        </encoder>
    </appender>

1740909497686.png

输出日志到文件

    <!-- 系统文件输出 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- 日志文件输出的文件名, %i表示序号 -->
            <FileNamePattern>D:/tlias-%d{yyyy-MM-dd}-%i.log</FileNamePattern>
            <!-- 最多保留的历史日志文件数量 -->
            <MaxHistory>30</MaxHistory>
            <!-- 最大文件大小，超过这个大小会触发滚动到新文件，默认为 10MB -->
            <maxFileSize>10MB</maxFileSize>
        </rollingPolicy>

        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d 表示日期，%thread 表示线程名，%-5level表示级别从左显示5个字符宽度，%msg表示日志消息，%n表示换行符 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%n</pattern>
        </encoder>
    </appender>

可以看到d盘下多了一个.log的文件，这是因为在xml中配置了日志输出的路径在d盘

在这里插入图片描述

日志级别

日志级别实际上就是日志的类型，常见的日志级别如下

在这里插入图片描述

上面表格从上到下级别依次增加，大于等于xml日志配置文件中的日志级别的日志才会输出，就比如配置了日志级别为info，那么只有info、warn、error才会输出，而debug、trace则不会输出

如何在项目中使用？直接在对应的项目上加上**@Slf4j**注解即可

相关文章：

  • 图漾PercipioIPTool软件使用
  • python基于后门的神经网络模型水印通用方法
  • AndroidStudio下载旧版本方法
  • miqiu的分布式锁（四）：MySQL悲观锁解析
  • 线程控制（创建、终止、等待、分离）
  • 定位需要优化的SQL ,及如何优化SQL
  • 深入xtquant：掌握市场基础信息的获取技巧
  • React 第二十七节 ＜StrictMode＞ 的使用方法及注意事项
  • Unity XR-XR Interaction Toolkit开发使用方法（十三）组件介绍（XR Grab Interactable）
  • 开源项目Wren AI 文本到SQL解决方案详解
  • 电池管理系统（BMS）架构详细解析：原理与器件选型指南
  • 力扣785. 判断二分图
  • 在AIStudio飞桨星河社区一键部署DeepSeek-r1:70b模型
  • leetcode第216题组合总和Ⅲ
  • 在笔记本电脑上用DeepSeek搭建个人知识库
  • 类似ComfyUI和Midjourney这样的文生图图生图应用的API与服务架构该怎么设计
  • linux shell脚本网络篇
  • LabVIEW正弦信号处理：FFT与最小二乘拟合的参数提取
  • 关于JavaScript性能问题的误解
  • Kotlin 运算符重载
  • 《掩耳盗邻》：富人劫富，是犯罪，也是赎罪？
  • 2024年全国博物馆接待观众14.9亿人次
  • 蔡建忠已任昆山市副市长、市公安局局长
  • 第十届曹禺剧本奖上海揭晓，首次开放个人申报渠道
  • 当智慧农场遇见绿色工厂：百事如何用科技留住春天的味道？
  • 穆迪下调美国主权信用评级