【Java 工具类 Hutool】项目中如何引入 Hutool 并正确使用它

左手的ㄟ右手 2024-05-04 08:10 65阅读 0赞

![在这里插入图片描述][3bd139b357224f31a7d4633ff0f8efd9.png]

> ?**博主介绍**： 博主从事应用安全和大数据领域，有8年研发经验，5年面试官经验，Java技术专家，WEB架构师，阿里云专家博主，华为云云享专家，51CTO 专家博主

⛪️**个人社区**：[个人社区][Link 1]  
? **个人主页**：[个人主页][Link 2]  
? **初级进阶地址**： ✅ [Java 初级进阶路线][Java]  
?**八股文专题**：[剑指大厂，手撕 Java 八股文][Java 1]

#### 文章目录 ####

*   *   *  **✨ 1. 项目中如何引入 Hutool** 
         *   *   **--- 1.1. import 方式引入 Hutool** 
             *   **--- 1.2. exclude 方式引入 Hutool** 
         *  **✨ 2. 以 SpringBoot 项目为例如何使用它**
         *  **✨ 3. Hutool 的编译安装**
         *  **✨ 4. Hutool 的源码分支说明**
         *  **✨ 5. 给 Hutool 提供bug反馈或建议**
         *  **✨ 6. 给 Hutool 贡献代码的步骤**
         *  **✨ 7. PR遵照的原则**

#### **✨ 1. 项目中如何引入 Hutool**  ####

#####  **— 1.1. import 方式引入 Hutool**  #####

如果你想像Spring-Boot一样引入Hutool，再由子模块决定用到哪些模块，你可以在父模块中加入：

<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>cn.hutool</groupId>
                <artifactId>hutool-bom</artifactId>
                <version>${hutool.version}</version>
                <type>pom</type>
                
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

在子模块中就可以引入自己需要的模块了：

<dependencies>
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-http</artifactId>
        </dependency>
    </dependencies>

使用 import 的方式，只会引入hutool-bom内的dependencyManagement的配置，其它配置在这个引用方式下完全不起作用。

#####  **— 1.2. exclude 方式引入 Hutool**  #####

如果你引入的模块比较多，但是某几个模块没用，你可以：

<dependencies>
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-bom</artifactId>
            <version>${hutool.version}</version>
            
            <type>pom</type>
            <exclusions>
                <exclusion>
                        <groupId>cn.hutool</groupId>
                        <artifactId>hutool-system</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

这个配置会传递依赖hutool-bom内所有dependencies的内容，当前hutool-bom内的dependencies全部设置了version，就意味着在maven resolve的时候hutool-bom内就算存在dependencyManagement也不会产生任何作用。

#### **✨ 2. 以 SpringBoot 项目为例如何使用它** ####

在Spring Boot项目中使用Hutool，您可以按照以下步骤进行操作：

1.  **添加Hutool依赖**：在您的项目的构建文件（如pom.xml）中添加Hutool的依赖项。您可以在Maven中添加以下依赖：

<dependency>
        <groupId>cn.hutool</groupId>
        <artifactId>hutool-all</artifactId>
        <version>5.7.6</version>
    </dependency>

1.  **在Spring Boot应用程序中使用Hutool**：在您的Spring Boot应用程序中，您可以直接使用Hutool提供的工具类和方法。例如，在您的Controller类中，您可以使用Hutool的字符串工具类：

import cn.hutool.core.util.StrUtil;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class MyController {
        
    
        @GetMapping("/hello")
        public String hello() {
        
            String str = "Hello, Hutool!";
            String reversedStr = StrUtil.reverse(str);
            return reversedStr;
        }
    }

1.  **运行应用程序**：启动您的Spring Boot应用程序，并访问 `/hello` 端点，您将看到使用Hutool进行字符串翻转后的结果。

#### **✨ 3. Hutool 的编译安装** ####

如果想对 Hutool 的源码进行编译安装，可以访问Hutool的Gitee主页：https://gitee.com/dromara/hutool (opens new window)下载整个项目源码（v5-master或v5-dev分支都可）然后进入Hutool项目目录执行：

./hutool.sh install

然后就可以使用Maven引入了。

#### **✨ 4. Hutool 的源码分支说明** ####

Hutool的源码分为两个分支，功能如下：

<table> 
 <thead> 
  <tr> 
   <th>分支</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>v5-master</td> 
   <td>主分支，release版本使用的分支，与中央库提交的jar一致，不接收任何pr或修改</td> 
  </tr> 
  <tr> 
   <td>v5-dev</td> 
   <td>开发分支，默认为下个版本的SNAPSHOT版本，接受修改或pr</td> 
  </tr> 
 </tbody> 
</table>

#### **✨ 5. 给 Hutool 提供bug反馈或建议** ####

提交问题反馈请说明正在使用的JDK版本呢、Hutool版本和相关依赖库版本。

[Gitee issue(opens new window)][Gitee issue_opens new window]  
[Github issue][]

#### **✨ 6. 给 Hutool 贡献代码的步骤** ####

1.  在Gitee或者Github上fork项目到自己的repo
2.  把fork过去的项目也就是你的项目clone到你的本地
3.  修改代码（记得一定要修改v5-dev分支）
4.  commit后push到自己的库（v5-dev分支）
5.  登录Gitee或Github在你首页可以看到一个 pull request 按钮，点击它，填写一些说明信息，然后提交即可。
6.  等待维护者合并

#### **✨ 7. PR遵照的原则** ####

Hutool欢迎任何人为Hutool添砖加瓦，贡献代码，不过维护者是一个强迫症患者，为了照顾病人，需要提交的pr（pull request）符合一些规范，规范如下：

1.  注释完备，尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息，必要时请添加单元测试，如果愿意，也可以加上你的大名。
2.  Hutool的缩进按照Eclipse（不要跟我说IDEA多好用，维护者非常懒，学不会 ，IDEA真香，改了Eclipse快捷键后舒服多了）默认（tab）缩进，所以请遵守（不要和我争执空格与tab的问题，这是一个病人的习惯）。
3.  新加的方法不要使用第三方库的方法，Hutool遵循无依赖原则（除非在extra模块中加方法工具）。
4.  请pull request到v5-dev分支。Hutool在5.x版本后使用了新的分支：v5-master是主分支，表示已经发布中央库的版本，这个分支不允许pr，也不允许修改。
5.  我们如果关闭了你的issue或pr，请不要诧异，这是我们保持问题处理整洁的一种方式，你依旧可以继续讨论，当有讨论结果时我们会重新打开。

>  精彩专栏推荐订阅：在下方专栏??  
>  ✅ [2023年华为OD机试真题（A卷&B卷）+ 面试指导 ][2023_OD_A_B_ _]  
>  ✅ [ 精选100套 Java 项目案例 ][_100_ Java _]  
>  ✅ [面试需要避开的坑（活动）][Link 3]  
>  ✅ [你找不到的核心代码][Link 4]  
>  ✅ [带你手撕 Spring][Spring]  
>  ✅ [Java 初阶][Java 2]

![在这里插入图片描述][7b7478e55aa24a948b358051ef941b6a.webp_pic_center]

[3bd139b357224f31a7d4633ff0f8efd9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/04/ae3dd112c2594a13a2d60967012d13af.png
[Link 1]: https://bbs.csdn.net/forums/45c04d3f41cc4dadaf312be1d1379b45?category=10003
[Link 2]: https://jiliu.blog.csdn.net/
[Java]: https://jiliu.blog.csdn.net/article/details/132450001
[Java 1]: https://blog.csdn.net/qq_37967783/article/details/130940512
[Gitee issue_opens new window]: https://gitee.com/dromara/hutool/issues
[Github issue]: https://github.com/dromara/hutool/issues
[2023_OD_A_B_ _]: https://blog.csdn.net/qq_37967783/category_12389634.html
[_100_ Java _]: https://blog.csdn.net/qq_37967783/category_12388267.html
[Link 3]: https://blog.csdn.net/qq_37967783/category_12380337.html
[Link 4]: https://blog.csdn.net/qq_37967783/category_12391346.html
[Spring]: https://blog.csdn.net/qq_37967783/category_12391987.html
[Java 2]: https://blog.csdn.net/qq_37967783/category_9902143.html
[7b7478e55aa24a948b358051ef941b6a.webp_pic_center]: https://img-blog.csdnimg.cn/7b7478e55aa24a948b358051ef941b6a.webp#pic_center