添加注释

This commit is contained in:
zk
2026-03-20 15:04:01 +08:00
parent 5417aa6105
commit 13520a6e39
2 changed files with 49 additions and 5 deletions
+11 -4
View File
@@ -22,20 +22,24 @@ offerpie/back-end
│ ├─ controller/ │ ├─ controller/
│ │ ├─ LoginController.java # 登录相关接口(发送验证码、短信登录) │ │ ├─ LoginController.java # 登录相关接口(发送验证码、短信登录)
│ │ ├─ RouteMenuController.java # 路由菜单接口(获取用户有效菜单树) │ │ ├─ RouteMenuController.java # 路由菜单接口(获取用户有效菜单树)
│ │ ─ UserProfileController.java # 用户个人资料接口(主表+5张子表的查询与保存) │ │ ─ UserProfileController.java # 用户个人资料接口(主表+5张子表的查询与保存)
│ │ └─ JobIntentionController.java # 求职意向接口(查询与保存)
│ ├─ service/ │ ├─ service/
│ │ ├─ LoginService.java # 登录业务逻辑(验证码校验、自动注册、JWT生成、Cookie设置) │ │ ├─ LoginService.java # 登录业务逻辑(验证码校验、自动注册、JWT生成、Cookie设置)
│ │ ├─ UserRegisterService.java # 用户注册服务(注册逻辑、邀请码生成与绑定) │ │ ├─ UserRegisterService.java # 用户注册服务(注册逻辑、邀请码生成与绑定)
│ │ ├─ FuncPermissionService.java # 功能权限服务(校验、扣减、查询、添加库存、回退) │ │ ├─ FuncPermissionService.java # 功能权限服务(校验、扣减、查询、添加库存、回退)
│ │ ├─ RouteMenuService.java # 路由菜单服务(查询、添加库存、获取用户菜单树) │ │ ├─ RouteMenuService.java # 路由菜单服务(查询、添加库存、获取用户菜单树)
│ │ ├─ UserProfileService.java # 用户个人资料服务(主表+5张子表的CRUD) │ │ ├─ UserProfileService.java # 用户个人资料服务(主表+5张子表的CRUD)
│ │ ├─ JobIntentionService.java # 求职意向服务(查询与保存/更新)
│ │ └─ WxPayNotifyMessageAbstractImpl.java # 微信支付回调实现 │ │ └─ WxPayNotifyMessageAbstractImpl.java # 微信支付回调实现
│ └─ pojo/ │ └─ pojo/
│ ├─ param/ │ ├─ param/
│ │ ─ userProfile/ # 个人资料入参(UserProfileParam、各子表Param │ │ ─ userProfile/ # 个人资料入参(UserProfileParam、各子表Param
│ │ └─ job/ # 岗位相关入参(JobIntentionParam
│ ├─ dto/ │ ├─ dto/
│ │ ├─ SmsLoginDto.java # 短信登录入参(mobileNumber + code + inviteCode │ │ ├─ SmsLoginDto.java # 短信登录入参(mobileNumber + code + inviteCode
│ │ ─ userProfile/ # 个人资料出参(UserProfileDto、各子表Dto │ │ ─ userProfile/ # 个人资料出参(UserProfileDto、各子表Dto
│ │ └─ job/ # 岗位相关出参(JobIntentionDto
│ └─ vo/ │ └─ vo/
│ ├─ LoginVo.java # 登录返回(userId + nick │ ├─ LoginVo.java # 登录返回(userId + nick
│ └─ RouteMenuVo.java # 路由菜单树形VO(含children子菜单) │ └─ RouteMenuVo.java # 路由菜单树形VO(含children子菜单)
@@ -60,7 +64,10 @@ offerpie/back-end
└─ src/main/java └─ src/main/java
└─ org.jiayunet └─ org.jiayunet
├─ constant/ # 常量枚举(OSS路径、短信模板等) ├─ constant/ # 常量枚举(OSS路径、短信模板等)
├─ controller/ # 对外 REST 接口(HealthCheck、Oss 等) ├─ controller/ # 对外 REST 接口(HealthCheck、Oss、字典查询等)
│ ├─ RegionController.java # 地区接口(树形/层级/搜索/批量查询)
│ ├─ JobCategoryController.java # 岗位分类接口(树形/层级/搜索/批量查询)
│ └─ IndustryController.java # 行业接口(树形/层级/搜索/批量查询)
├─ mapper/ # MyBatis Mapper ├─ mapper/ # MyBatis Mapper
│ ├─ UserMapper.java │ ├─ UserMapper.java
│ ├─ OssFileMapper.java │ ├─ OssFileMapper.java
@@ -14,7 +14,8 @@ import java.util.List;
import java.util.stream.Collectors; import java.util.stream.Collectors;
/** /**
* 用户个人资料控制类 * 用户个人资料接口
* 提供主表及5张子表(教育/工作/实习/项目/竞赛)的查询与保存功能
* *
* @author zk * @author zk
*/ */
@@ -28,6 +29,9 @@ public class UserProfileController {
// ==================== 主表 ==================== // ==================== 主表 ====================
/**
* 查询当前用户的个人资料主表
*/
@GetMapping @GetMapping
public UserProfileDto getProfile() { public UserProfileDto getProfile() {
UserProfile po = userProfileService.getProfile(); UserProfile po = userProfileService.getProfile();
@@ -39,6 +43,9 @@ public class UserProfileController {
return dto; return dto;
} }
/**
* 保存/更新当前用户的个人资料主表
*/
@PostMapping @PostMapping
public void saveProfile(@Validated @RequestBody UserProfileParam param) { public void saveProfile(@Validated @RequestBody UserProfileParam param) {
UserProfile po = new UserProfile(); UserProfile po = new UserProfile();
@@ -48,6 +55,9 @@ public class UserProfileController {
// ==================== 教育经历 ==================== // ==================== 教育经历 ====================
/**
* 查询当前用户的教育经历列表
*/
@GetMapping("/education") @GetMapping("/education")
public List<UserProfileEducationDto> listEducation() { public List<UserProfileEducationDto> listEducation() {
return userProfileService.listEducation().stream().map(po -> { return userProfileService.listEducation().stream().map(po -> {
@@ -57,6 +67,9 @@ public class UserProfileController {
}).collect(Collectors.toList()); }).collect(Collectors.toList());
} }
/**
* 保存当前用户的教育经历列表(全量替换)
*/
@PostMapping("/education") @PostMapping("/education")
public void saveEducation(@Validated @RequestBody List<@Valid UserProfileEducationParam> params) { public void saveEducation(@Validated @RequestBody List<@Valid UserProfileEducationParam> params) {
List<UserProfileEducation> list = params.stream().map(p -> { List<UserProfileEducation> list = params.stream().map(p -> {
@@ -69,6 +82,9 @@ public class UserProfileController {
// ==================== 工作经历 ==================== // ==================== 工作经历 ====================
/**
* 查询当前用户的工作经历列表
*/
@GetMapping("/work") @GetMapping("/work")
public List<UserProfileWorkDto> listWork() { public List<UserProfileWorkDto> listWork() {
return userProfileService.listWork().stream().map(po -> { return userProfileService.listWork().stream().map(po -> {
@@ -78,6 +94,9 @@ public class UserProfileController {
}).collect(Collectors.toList()); }).collect(Collectors.toList());
} }
/**
* 保存当前用户的工作经历列表(全量替换)
*/
@PostMapping("/work") @PostMapping("/work")
public void saveWork(@Validated @RequestBody List<@Valid UserProfileWorkParam> params) { public void saveWork(@Validated @RequestBody List<@Valid UserProfileWorkParam> params) {
List<UserProfileWork> list = params.stream().map(p -> { List<UserProfileWork> list = params.stream().map(p -> {
@@ -90,6 +109,9 @@ public class UserProfileController {
// ==================== 实习经历 ==================== // ==================== 实习经历 ====================
/**
* 查询当前用户的实习经历列表
*/
@GetMapping("/internship") @GetMapping("/internship")
public List<UserProfileInternshipDto> listInternship() { public List<UserProfileInternshipDto> listInternship() {
return userProfileService.listInternship().stream().map(po -> { return userProfileService.listInternship().stream().map(po -> {
@@ -99,6 +121,9 @@ public class UserProfileController {
}).collect(Collectors.toList()); }).collect(Collectors.toList());
} }
/**
* 保存当前用户的实习经历列表(全量替换)
*/
@PostMapping("/internship") @PostMapping("/internship")
public void saveInternship(@Validated @RequestBody List<@Valid UserProfileInternshipParam> params) { public void saveInternship(@Validated @RequestBody List<@Valid UserProfileInternshipParam> params) {
List<UserProfileInternship> list = params.stream().map(p -> { List<UserProfileInternship> list = params.stream().map(p -> {
@@ -111,6 +136,9 @@ public class UserProfileController {
// ==================== 项目经历 ==================== // ==================== 项目经历 ====================
/**
* 查询当前用户的项目经历列表
*/
@GetMapping("/project") @GetMapping("/project")
public List<UserProfileProjectDto> listProject() { public List<UserProfileProjectDto> listProject() {
return userProfileService.listProject().stream().map(po -> { return userProfileService.listProject().stream().map(po -> {
@@ -120,6 +148,9 @@ public class UserProfileController {
}).collect(Collectors.toList()); }).collect(Collectors.toList());
} }
/**
* 保存当前用户的项目经历列表(全量替换)
*/
@PostMapping("/project") @PostMapping("/project")
public void saveProject(@Validated @RequestBody List<@Valid UserProfileProjectParam> params) { public void saveProject(@Validated @RequestBody List<@Valid UserProfileProjectParam> params) {
List<UserProfileProject> list = params.stream().map(p -> { List<UserProfileProject> list = params.stream().map(p -> {
@@ -132,6 +163,9 @@ public class UserProfileController {
// ==================== 竞赛经历 ==================== // ==================== 竞赛经历 ====================
/**
* 查询当前用户的竞赛经历列表
*/
@GetMapping("/competition") @GetMapping("/competition")
public List<UserProfileCompetitionDto> listCompetition() { public List<UserProfileCompetitionDto> listCompetition() {
return userProfileService.listCompetition().stream().map(po -> { return userProfileService.listCompetition().stream().map(po -> {
@@ -141,6 +175,9 @@ public class UserProfileController {
}).collect(Collectors.toList()); }).collect(Collectors.toList());
} }
/**
* 保存当前用户的竞赛经历列表(全量替换)
*/
@PostMapping("/competition") @PostMapping("/competition")
public void saveCompetition(@Validated @RequestBody List<@Valid UserProfileCompetitionParam> params) { public void saveCompetition(@Validated @RequestBody List<@Valid UserProfileCompetitionParam> params) {
List<UserProfileCompetition> list = params.stream().map(p -> { List<UserProfileCompetition> list = params.stream().map(p -> {