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

一.准备环境，从零开始搭建项目

article 2024/12/5 3:22:58

此系列内容旨在记录自己从0搭建企业级开发框架的全过程，也为巩固自己的知识，话不多说，直接开干

前言

开发环境

一、创建父项目

二、创建子项目 - 公共模块

三、创建子项目 - 对外接口模块

3.1 添加依赖

3.2 配置springboot文件

3.3 创建Spring启动类

四、最终目录结构

总结

前言

一个项目中一定会包含多个模块，把每个模块单独分开势在必行，本项目采用父子项目结构搭建，将每个模块单独分开，代码结构清晰

开发环境

springboot3.3.6 + java17 + gradle8.11 + IDEA2024.3

工欲善其事必先利其器，以上的软件环境安装这里不做介绍，利用google分分钟搞定

一、创建父项目

1.新建项目

创建完成后删除src目录，保留以下文件目录即可

2.项目配置build.gradle

// 定义插件依赖
plugins {
    // 应用Java插件，用于Java项目的构建
    id 'java'
    // 应用Spring Boot插件，但不自动应用到子项目
    id 'org.springframework.boot' version '3.3.6' apply false
    // 应用Spring依赖管理插件
    id 'io.spring.dependency-management' version '1.1.6'
}

// 对所有项目应用以下配置
allprojects {
    // 设置项目的组标识符
    group = 'com.light'
    // 设置项目的版本
    version = '1.0-SNAPSHOT'
    // 配置项目的仓库
    repositories {
        // 使用本地Maven仓库
        mavenLocal()
        // 使用阿里云的公共Maven仓库
        maven { url 'https://maven.aliyun.com/repository/public/' }
        // 使用Maven中央仓库
        mavenCentral()
    }
}

// 对子项目应用以下配置
subprojects {
    // 应用Java插件
    apply plugin: 'java'
    // 应用IDEA插件，用于支持IDEA开发环境
    apply plugin: 'idea'
    // 应用Spring Boot插件
    apply plugin: 'org.springframework.boot'
    // 应用Spring依赖管理插件
    apply plugin: 'io.spring.dependency-management'

    // 配置项目的依赖
    dependencies {
        // 添加Spring Boot启动器依赖，用于提供Spring Boot的核心功能
        implementation 'org.springframework.boot:spring-boot-starter'
    }
    // 配置Java版本
    java {
        // 设置源代码兼容性为Java 17
        sourceCompatibility = JavaVersion.VERSION_17
        // 设置目标字节码兼容性为Java 17
        targetCompatibility = JavaVersion.VERSION_17
        // 配置工具链，确保使用的Java版本为17
        toolchain {
            languageVersion = JavaLanguageVersion.of(17)
        }
    }
}

二、创建子项目 - 公共模块

选中父项目，【右键】选择创建模块ligth-common

此时点开父项目的setting.gradle,看到已经关联了我们的子项目light-common

三、创建子项目 - 对外接口模块

创建过程和步骤2一样，这里不再重复，创建后的目录结构如下

3.1 添加依赖

创建好项目后，打开build.gradle;

添加需要引入的子模块light-common和spring-boot-starter-web

plugins {
    id 'java'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation project(":light-common")
    implementation 'org.springframework.boot:spring-boot-starter-web'
}

3.2 配置springboot文件

在resources目录下创建application.yml文件，这里我们先简单配置一些内容，后续根据需要再逐步添加

spring:
  application:
    name: light-api

server:
  port: 9001

3.3 创建Spring启动类

在java目录下创建包com.light.api，并在该包下创建一个启动类LightApiApplication

package com.light.api;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 启动入口
 */
@SpringBootApplication
public class LightApiApplication {
    public static void main(String[] args) {
        SpringApplication.run(LightApiApplication.class, args);
    }
}

创建完成后，运行LightApiApplication类，运行成功无报错即大功告成