java-web/docs/chapter07.md

214 lines
6.4 KiB
Markdown
Raw Normal View History

2024-08-08 11:12:49 +08:00
## 7. 项目实践
2024-11-15 12:36:48 +08:00
基于开源项目 https://github.com/rocboss/paopao-ce , 使用spring boot完成后端服务程序。
### 7.1 项目准备
#### 7.1.1 Git仓库
2024-11-19 11:19:08 +08:00
- 创建远程项目仓库
2024-11-18 07:25:42 +08:00
2024-11-19 11:19:08 +08:00
在http://123.249.84.124:8066/ 注册账号 创建仓库paopao
> 选择.gitignore文件模板 java
> 设置分支模型: 单分支模型分支名master
- 在idea中clone项目
idea的菜单`file -> new -> project from version control -> Repository URL`url输入框中输入项目的远程仓库地址点击`clone`。
2024-11-15 12:36:48 +08:00
#### 7.1.2 初始化spring boot项目
2024-11-19 11:19:08 +08:00
#### 使用 Spring Initializr 创建项目
- 访问 [Spring Initializr](https://start.spring.io/)
- 选择以下选项:
- **Project:** Gradle-Groovy
- **Language:** Java
- **Spring Boot:** 选择最新稳定版本
- **Group:** 输入你的组织名称(例如 `com.lk`
- **Artifact:** 输入项目名称(例如 `paopao`
- **Name:** 项目名称(默认与 Artifact 相同)
- **Package name:** 包名(默认与 Group 和 Artifact 相同)
- **Packaging:** Jar
- **Java Version:** 选择合适的 Java 版本17或21
- 添加以下依赖:
- **Web**
- **JPA**
- **H2 Database**
- 点击 `Generate` 按钮,下载生成的项目压缩包。
#### 解压并复制文件
- 将下载的压缩包解压到一个临时目录。
- 将解压后的目录中的所有文件复制到你的本地项目根目录下。
- 确保 `build.gradle` 等文件位于项目根目录下。
#### 在 IDEA 中设置项目
a. **打开项目**
- 打开 IntelliJ IDEA。
- 选择 `File` -> `Open`,选择你的项目根目录,然后点击 `OK`
b. **设置项目使用的 JDK**
- 打开 `File` -> `Project Structure`
-`Project` 标签页中,选择 `Project SDK`,选择你安装的 JDK 或者下载JDK再选择。
c. **配置 Gradle 使用的 JVM 版本**
- 打开 `File` -> `Settings`(或按 `Ctrl+Alt+S`)。
- 导航到 `Build, Execution, Deployment` -> `Build Tools` -> `Gradle`
-`Gradle JVM` 下拉菜单中,选择你安装的 JDK 版本, 保持使用的版本和项目jdk版本一致。如果看不到此项尝试下面的步骤d,重新导入项目)
d. **导入项目**
- 如果项目没有自动导入,可以手动导入:
- 打开 `File` -> `New` -> `Module from Existing Sources`
- 选择项目根目录下的 `build.gradle` 文件,然后按照提示完成导入。
完成以上步骤后应该能在idea的右侧插件栏中看到gradle的图标。
2024-11-15 12:36:48 +08:00
#### 7.1.3 gradle配置
2024-11-19 11:19:08 +08:00
项目中的gradle/wrapper/gradle-wrapper.properties 文件中将下载的gradle地址修改为使用国内源。
```properties
distributionUrl=https://mirrors.cloud.tencent.com/gradle/gradle-8.5-bin.zip
```
项目中build.gradle 文件中设置使用国内maven服务器添加如下配置
2024-11-18 07:25:42 +08:00
```groovy
repositories {
mavenLocal()
maven { url 'https://mirrors.cloud.tencent.com/nexus/repository/maven-public/' }
maven { url 'https://maven.aliyun.com/repository/central' }
maven { url 'https://maven.aliyun.com/repository/public' }
mavenCentral()
}
```
2024-11-19 11:19:08 +08:00
项目中build.gradle 文件中修改h2数据库的依赖,指定版本号使用H2 V2(为了使用数据库工具dbeaver时比较方便设置)
2024-11-18 07:43:18 +08:00
```groovy
runtimeOnly 'com.h2database:h2:2.1.214'
```
2024-11-15 12:36:48 +08:00
2024-11-19 11:19:08 +08:00
修改完成后刷新gradle, 等待gradle下载依赖。
下载完成在gradle插件的窗口中运行`tasks`,选择`bootRun`任务。项目应能正常运行。
在idea中使用git菜单,将项目所有更新提交到远程仓库.
2024-11-15 12:36:48 +08:00
#### 7.1.4 ui部署
2024-11-18 07:25:42 +08:00
nginx中部署 [paopao-web-ui.zip](../examples/chapter07/paopao-web-ui.zip)
2024-11-15 12:36:48 +08:00
2024-11-19 11:19:08 +08:00
- 安装nginx
下载nginx https://nginx.org/download/nginx-1.26.2.zip
解压zip包在解压后的目录下运行nginx.exe, 即可启动nginx服务。
在浏览器中访问http://localhost 应能看到nginx的欢迎界面。
- 发布前端代码
前端代码压缩文件`paopao-web-ui.zip`解压, 将前端代码根目录下的所有文件拷贝到html目录下重启nginx服务。
浏览器访问http://localhost/index.html
2024-11-18 07:43:18 +08:00
2024-11-15 12:36:48 +08:00
### 7.2 用户注册功能开发
2024-11-19 11:19:08 +08:00
基本上按照层次结构创建系统的包结构, 在`com.lk.paopao`包下创建子包`controllers`、`services`、`entities`、`repositories`。
2024-11-15 12:36:48 +08:00
#### 7.2.1 API设计
2024-11-19 11:19:08 +08:00
[用户注册API.md](./resources/用户注册API.md)
2024-11-15 12:36:48 +08:00
#### 7.2.2 spring boot配置文件修改
2024-11-19 11:19:08 +08:00
在项目目录`src/main/resources`下新建application.yml文件添加数据库相关配置
```yaml
spring:
jackson:
property-naming-strategy: SNAKE_CASE # 驼峰转下划线,以适应数据库字段命名规则
datasource:
url: jdbc:h2:file:./db.h2 # 使用文件存储配置数据库连接URL
driverClassName: org.h2.Driver # 指定数据库驱动类
username: root # 数据库用户名
password: root # 数据库密码
h2:
console: # 开启console访问 默认false提供数据库管理界面
enabled: true # 启用H2控制台访问功能
settings:
trace: true # 开启h2 console 跟踪 方便调试 默认 false
web-allow-others: true # 允许console 远程访问 默认false提高可用性
path: /h2 # h2 访问路径上下文,定义访问路由
jpa:
show-sql: true # 显示SQL查询便于调试和性能优化
open-in-view: false # 禁用Open SessionInView避免性能问题和资源泄露
defer-datasource-initialization: true # 延迟数据源初始化,确保配置加载完成
database-platform: org.hibernate.dialect.H2Dialect # 指定数据库方言优化SQL生成
hibernate:
ddl-auto: update # 自动更新数据库结构,适应实体模型变化
```
yml配置文件的格式需要注意缩进和空格是敏感的需要严格遵循格式。
2024-11-15 12:36:48 +08:00
#### 7.2.3 实体类和Repository接口
2024-11-19 11:19:08 +08:00
设计和实现实体类User
对应的数据库接口: UserRepository
2024-11-15 12:36:48 +08:00
#### 7.2.3 Controller和service
2024-11-19 11:19:08 +08:00
#### 7.2.4 解决跨域问题
2024-11-15 12:36:48 +08:00
### 7.3 发布文章功能开发
#### 7.3.1 API
#### 7.3.2 实体类和Repository接口
#### 7.3.3 Controller和service
#### 7.3.4 实现统一包装回应数据
### 7.3 附件上传功能开发
#### 7.3.1 API
#### 7.3.2 实体类和Repository接口
#### 7.3.3 Controller和service
2024-11-16 11:13:31 +08:00
### 7.4 文章相关功能开发
2024-11-15 12:36:48 +08:00
#### 7.4.1 API设计
#### 7.4.2 功能实现
2024-11-15 12:44:53 +08:00
文章查询、评论功能、点赞、收藏
2024-11-15 12:36:48 +08:00
2024-11-15 12:44:53 +08:00
#### 7.4.3 DTO
2024-11-15 12:36:48 +08:00
2024-11-15 12:44:53 +08:00
#### 7.4.4 lombok和mapstruct
2024-11-15 12:36:48 +08:00
### 7.5 部署