lamp-util核心工具包使用教程

lamp-util核心工具包使用教程

lamp-utillamp-util 基jdk8 /jdk11/jdk17 ，是 lamp-cloud 和 lamp-boot 项目的核心工具包，开发宗旨是打造一套兼顾 SpringBoot 和 SpringCloud 项目的公共工具类。项目地址:https://gitcode.com/gh_mirrors/la/lamp-util

---

1. 项目介绍

lamp-util 是一款基于 JDK 8/11/17 开发的核心工具包，专为 lamp-cloud 和 lamp-boot 项目设计，旨在实现一套适用于 Spring Boot 和 Spring Cloud 项目的通用工具集合。它秉承着高内聚低耦合的原则，提供了一系列丰富的功能，包括但不限于：

• Mvc封装：通用的 Controller、Service、Mapper 层以及全局异常处理。
• SpringCloud封装：优化了请求头传递、调用日志记录、灰度发布、配置编码解码等功能。
• 数据回显：有效处理跨库表及服务间的字段关联显示问题。
• 持久层增强：扩展 MyBatis Plus 的功能，集成数据权限管理，自定义类型处理器。

此外，它还特别解决了枚举和字典等字段在传输中的编码与中文显示问题，非常适合前后端分离项目中对数据交互有特定需求的场景。

---

2. 项目快速启动

为了快速体验 lamp-util，首先确保你的开发环境已经安装了 Git、Java 11 或更高版本，以及 Maven。

步骤一：克隆项目

git clone https://github.com/zuihou/lamp-util.git

步骤二：构建项目

进入项目目录并执行 Maven 清理与构建命令：

cd lamp-util
mvn clean install

这将下载所有必要的依赖并编译项目，生成对应的 JAR 文件或依赖包，供其他项目使用。

步骤三：集成到你的项目

在你的 Spring Boot 或 Spring Cloud 项目中，通过添加以下 Maven 依赖来集成 lamp-util：

<dependency>
    <groupId>com.github.zuihou</groupId>
    <artifactId>lamp-util</artifactId>
    <version>{latest-version}</version> <!-- 替换成实际的最新版本 -->
</dependency>

记得替换 {latest-version} 为实际发布的最新版本号，你可以从 Maven 中央仓库或项目的 Release 页面获取。

---

3. 应用案例和最佳实践

在使用 lamp-util 进行开发时，可以利用其提供的枚举映射功能简化前后端的交互。例如，假设你有一个状态枚举需要在响应中友好展示：

import com.github.zuihou.utils.EnumUtils;

public enum StatusEnum {
    ACTIVE("活动"),
    INACTIVE("未激活");

    private String description;

    StatusEnum(String description) {
        this.description = description;
    }

    public static String getDescriptionByCode(String code) {
        return EnumUtils.getDescriptionByCode(StatusEnum.class, code);
    }
}

在控制器中，你可以直接使用这个枚举，而不需要手动转换描述：

@GetMapping("/status")
public ResponseDTO<StatusEnum> getStatus() {
    return ResponseDTO.success(StatusEnum.ACTIVE);
}

前端接收到的数据将会自动使用描述而非代码展示，提升了用户体验。

---

4. 典型生态项目

lamp-util 作为核心组件，通常与 lamp-cloud 和 lamp-boot 项目配合使用。在大型分布式系统开发中，这些生态项目共同构成了快速开发平台，提供了：

• lamp-cloud：基于 Spring Cloud 的微服务解决方案。
• lamp-boot：面向单体应用的 Spring Boot 版本。

在开发微服务架构或单体应用时，利用 lamp-cloud 或 lamp-boot 结合 lamp-util 可以快速搭建起具备完整基础能力的项目骨架，大幅提高开发效率。具体的生态项目集成需遵循各自的文档指引，确保各组件之间的版本兼容性。

---

通过上述步骤和实践指导，你可以迅速上手并发挥 lamp-util 在提升项目开发效率和质量上的强大作用。记住，在实际应用中结合具体场景调整，探索更多可能性。

lamp-utillamp-util 基jdk8 /jdk11/jdk17 ，是 lamp-cloud 和 lamp-boot 项目的核心工具包，开发宗旨是打造一套兼顾 SpringBoot 和 SpringCloud 项目的公共工具类。项目地址:https://gitcode.com/gh_mirrors/la/lamp-util