mirror of
https://gitee.com/many2many/java-web.git
synced 2025-01-11 14:40:55 +08:00
c7 changed
This commit is contained in:
parent
02c2ed91c8
commit
bb6867d6d6
@ -7,17 +7,75 @@
|
||||
|
||||
#### 7.1.1 Git仓库
|
||||
|
||||
在http://123.249.84.124:8066/ 注册账号
|
||||
- 创建远程项目仓库
|
||||
|
||||
创建仓库 paopao
|
||||
在http://123.249.84.124:8066/ 注册账号 ， 创建仓库paopao
|
||||
|
||||
> 选择.gitignore文件模板： java
|
||||
|
||||
> 设置分支模型： 单分支模型，分支名：master
|
||||
|
||||
- 在idea中clone项目
|
||||
|
||||
idea的菜单`file -> new -> project from version control -> Repository URL`，url输入框中输入项目的远程仓库地址，点击`clone`。
|
||||
|
||||
#### 7.1.2 初始化spring boot项目
|
||||
|
||||
https://start.spring.io/ 创建项目
|
||||
#### 使用 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的图标。
|
||||
|
||||
#### 7.1.3 gradle配置
|
||||
|
||||
国内源配置
|
||||
项目中的gradle/wrapper/gradle-wrapper.properties 文件中，将下载的gradle地址修改为使用国内源。
|
||||
|
||||
```properties
|
||||
distributionUrl=https://mirrors.cloud.tencent.com/gradle/gradle-8.5-bin.zip
|
||||
```
|
||||
|
||||
项目中build.gradle 文件中，设置使用国内maven服务器，添加如下配置：
|
||||
|
||||
```groovy
|
||||
repositories {
|
||||
mavenLocal()
|
||||
@ -27,28 +85,92 @@ repositories {
|
||||
mavenCentral()
|
||||
}
|
||||
```
|
||||
H2 V2的JDBC驱动依赖：
|
||||
项目中build.gradle 文件中，修改h2数据库的依赖,指定版本号，使用H2 V2(为了使用数据库工具dbeaver时比较方便设置)：
|
||||
|
||||
```groovy
|
||||
runtimeOnly 'com.h2database:h2:2.1.214'
|
||||
```
|
||||
|
||||
修改完成后，刷新gradle, 等待gradle下载依赖。
|
||||
|
||||
下载完成，在gradle插件的窗口中，运行`tasks`，选择`bootRun`任务。项目应能正常运行。
|
||||
|
||||
在idea中使用git菜单,将项目所有更新提交到远程仓库.
|
||||
|
||||
|
||||
#### 7.1.4 ui部署
|
||||
|
||||
nginx中部署 [paopao-web-ui.zip](../examples/chapter07/paopao-web-ui.zip)
|
||||
|
||||
[Spring Boot处理CORS跨域请求的三种方法](https://cloud.tencent.com/developer/article/1655583)
|
||||
- 安装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
|
||||
|
||||
|
||||
### 7.2 用户注册功能开发
|
||||
|
||||
基本上按照层次结构创建系统的包结构, 在`com.lk.paopao`包下创建子包`controllers`、`services`、`entities`、`repositories`。
|
||||
|
||||
|
||||
#### 7.2.1 API设计
|
||||
|
||||
[用户注册API.md](./resources/用户注册API.md)
|
||||
|
||||
#### 7.2.2 spring boot配置文件修改
|
||||
|
||||
在项目目录`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配置文件的格式需要注意：缩进和空格是敏感的，需要严格遵循格式。
|
||||
|
||||
#### 7.2.3 实体类和Repository接口
|
||||
|
||||
设计和实现实体类User
|
||||
|
||||
|
||||
|
||||
对应的数据库接口： UserRepository
|
||||
|
||||
|
||||
|
||||
#### 7.2.3 Controller和service
|
||||
|
||||
#### 7.2.4 测试
|
||||
#### 7.2.4 解决跨域问题
|
||||
|
||||
### 7.3 发布文章功能开发
|
||||
|
||||
|
||||
84
docs/resources/用户注册API.md
Normal file
84
docs/resources/用户注册API.md
Normal file
@ -0,0 +1,84 @@
|
||||
## 1. 用户注册
|
||||
|
||||
### 1.1 接口描述
|
||||
用户输入账号、邮箱、密码完成注册。
|
||||
### 1.2 请求URL
|
||||
`/v1/auth/register`
|
||||
|
||||
### 1.3 请求方式
|
||||
**POST**
|
||||
|
||||
### 1.4 请求头
|
||||
| 头字段 | 必填 | 数据类型 | 描述 |
|
||||
| ------------ | ---- | ------------- | -------------------------------- |
|
||||
| Content-Type | 是 | application/json | 指定请求体的媒体类型为JSON |
|
||||
|
||||
### 1.5 请求体参数
|
||||
| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 | 示例 | 允许空值 |
|
||||
|-----------| ---- | -------- | -------- | ---------------------------- | ------------ | -------- |
|
||||
| username | 是 | 字符串 | 1-50字符 | 用于登录的账号（手机号或邮箱） | "user123" | 否 |
|
||||
| password | 是 | 字符串 | 1-50字符 | 密码 | "p@ssw0rd" | 否 |
|
||||
|
||||
|
||||
### 1.6 请求示例
|
||||
```http
|
||||
POST /v1/auth/register
|
||||
Host: {apiAddress}
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"username": "a123",
|
||||
"password": "123456"
|
||||
}
|
||||
```
|
||||
|
||||
### 1.7 返回参数说明
|
||||
| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 |
|
||||
|------| ---- | -------- | -- |-----------|
|
||||
| code | 是 | 整型 | | 错误码，0表示成功 |
|
||||
| msg | 否 | 字符串 | | 错误信息描述 |
|
||||
| data | 否 | json | | 具体业务数据 |
|
||||
|
||||
data结构说明：
|
||||
|
||||
| 参数名称 | 必填 | 数据类型 | 约束条件 | 描述 |
|
||||
|-----------| ---- | -------- |--------| ---------------------------- |
|
||||
| id | 是 | 整型 | | 用户id |
|
||||
| username | 是 | 字符串 | 1-32字符 | 登录账号|
|
||||
|
||||
|
||||
|
||||
### 1.8 响应示例（成功）
|
||||
|
||||
```json
|
||||
{"code":0,"msg":"success","data":{"id":100067,"username":"a123"}}
|
||||
```
|
||||
### 1.9 响应示例（错误）
|
||||
```json
|
||||
{ "code": 409, "msg": "用户名存在" }
|
||||
```
|
||||
|
||||
### 1.10 错误响应码参考
|
||||
更多响应错误码及含义，请参阅[API响应码表](URL/for/api/responseCode/table)。
|
||||
|
||||
### 1.11 安全性与认证
|
||||
|
||||
|
||||
### 1.12 测试环境
|
||||
访问测试环境以进行接口调试：
|
||||
[https://test.apiAddress.com](https://test.apiAddress.com)
|
||||
|
||||
### 1.13 版本管理
|
||||
本API通过URI路径进行版本控制。请在请求URL中包含`/v1`以使用当前版本。
|
||||
|
||||
### 1.14 更新记录
|
||||
- **2024-05-07**：添加data结构说明
|
||||
- **2024-04-29**：发布文档初始版本。
|
||||
|
||||
|
||||
### 1.15 联系支持
|
||||
如需帮助或对API有任何疑问，请通过电子邮件与我们联系：[support@api.com](mailto:support@api.com)。
|
||||
|
||||
### 1.16 反馈与建议
|
||||
发现文档问题或有改进建议？请填写[反馈表单](https://forms.api.com/feedback)与我们分享。
|
||||
|
||||
Loading…
Reference in New Issue
Block a user