探索代码的奇妙旅程：JQL——SQL在Java源码中的应用

2024-06-10 17:51:24作者：温玫谨Lighthearted

Build Status

提示：本项目尚处于早期阶段，旨在评估和获取反馈。尝试一下，并告诉我们你的想法吧！

1、项目介绍

JQL（Java Query Language）是一个创新的开源工具，它允许开发者以SQL查询的方式来探索和理解Java源代码。想象一下，你可以像查找数据库记录一样，轻松地找到那些没有单元测试的类，或者查询最长的类名，甚至是寻找接口中拥有超过20个方法的情况。

2、项目技术分析

JQL的工作原理是将Java代码库转换为一个关系型数据库，然后通过标准SQL进行查询。其核心模型包括了诸如类型(Type)、类(Class)、接口(Interface)、方法(Method)等实体，以及它们之间的关系。例如，一个类可以有多个方法，而一个方法又属于一个特定的类型或接口。

实体与关系

表示实体图
显示了这些实体间的关系

详细的数据库模式描述可在项目wiki中查看。

3、项目及技术应用场景

JQL适用于以下场景：

代码质量检查：通过查询确定代码是否符合最佳实践，如无测试的类、过长的类名等。
代码审计：在接手新项目时，快速了解代码结构和可能的问题点。
重构准备：找出过度复杂的接口和类，以便进行重构。
团队教学：帮助新人快速理解和掌握项目代码结构。

4、项目特点

直观易用：使用熟悉的SQL语言，降低了学习成本。
灵活多变：任何关于代码结构的问题，都可以转化为SQL查询来解答。
开箱即用：提供单一可执行jar文件，简单命令即可完成代码分析。
Maven集成：对于Maven项目，可以通过插件直接进行集成。

如何开始？

运行以下命令即可创建数据库并分析指定的Java项目：

java -jar jql-core-0.1.jar /path/to/project/to/analyse /path/to/database/directory

对于Maven项目，只需在根目录下执行：

mvn io.github.benas:jql-maven-plugin:index

然后，使用您喜欢的SQL客户端打开生成的jql.db文件，开始编写您的查询吧！

完整的启动指南见这里。

贡献与支持

欢迎任何形式的贡献，无论是建议改进关系模型，还是发现无法回答的问题。请尝试使用JQL分析代码库，或者下载预处理的数据库样本，编写查询，如果遇到问题，请打开issue分享你的发现。

JQL感谢JavaParser提供的代码解析支持，以及Sqlite提供的数据库服务。

许可证

JQL遵循MIT许可证：

MIT License

Copyright (c) 2016, Mahmoud Ben Hassine (mahmoud.benhassine@icloud.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

准备好开启你的代码探索之旅了吗？JQL期待你的加入！