【Springboot开发】后端代码基础框架

前言：主要介绍最基础的springboot开发架构

目录

  • 1. overall
  • 2. 配置文件
    • 2.1 YAML
    • 2.2 properties
    • 2.3 配置文件加载顺序
    • 2.4 多配置文件
  • 3. 代码包
    • 3.1 infrastructure
      • 3.1.1 persistence
    • 3.2 application
      • 3.2.1 dto
      • 3.2.2 converter
      • 3.2.3 service
    • 3.3 api
      • 3.3.1 vo
      • 3.3.2 req
      • 3.3.3 converter
      • 3.3.4 controller
  • **结语**

1. overall

在这里插入图片描述
核心部分主要是src包，main包存放的是后端代码，test是用于测试main包的代码。main包主要包含以下几个部分：

  • java：存放后端代码
  • resources：存放配置文件
  • webapp：存放资源文件，如前端jsp、图片资源等

2. 配置文件

springboot使用固定名字的配置文件：application.properties或application.yml。

2.1 YAML

基本语法

  • 使用缩进表示层级关系
  • 缩进时不允许使用Tab键，只允许使用空格
  • 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
  • 大小写敏感

yml举例：

server:port: 8080

2.2 properties

properties举例：

spring.application.name=apply

2.3 配置文件加载顺序

  1. 按目录。位置高的将覆盖位置低的。
    在这里插入图片描述
  2. application.properties 的优先级高于 application.yml
  3. 互补读取：
  • 如果优先级高的配置文件中没有某个配置项，则会到优先级低的配置文件中找该配置项，即具有互补功能。
  • 文件名相同才会互补

2.4 多配置文件

有时候为了分开produce和test配置，会使用多个配置文件。
在这里插入图片描述
这种情况下可以在application.yml文件中指定使用的配置文件：
在这里插入图片描述

3. 代码包

代码包的路径为：
在这里插入图片描述
其中buildbaseframe为项目名。
后端代码主要包含以下几个部分：

  • BuildBaseFrameApplication: 启动类
  • utils：工具代码包
  • infrastructure
  • application
  • api

3.1 infrastructure

对应数据访问层，主要包含：

  • common包: 底层的一些公共配置
  • 模块包: 如用户模块
    在这里插入图片描述
    本节主要对各个模块包进行说明。

3.1.1 persistence

数据持久化层，主要包括mysql和repository。

  1. mysql
    主要是用来和数据库做绑定，映射对象到PO。
    在这里插入图片描述
    xml文件固定格式为：
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.buildbaseframe.infrastructure.user.persistence.mysql.mapper.UserPoMapper"><select id="findThis" resultType="com.example.buildbaseframe.infrastructure.user.persistence.repository.po.UserPo">select *from t_userwhere id = #{id}</select>
</mapper>

namespace是为了绑定mysql包下对应的映射文件，下写各种sql操作语句。
xxxPoMapper文件是为了做数据库对象和PO对象的映射，举例：

@Mapper
public interface UserPoMapper extends BaseMapper<UserPo> {/*** 测试xml方式绑定查询*/UserPo findThis(@Param("id") Long id);}
  • PoMapper文件只需要写一个接口继承自BaseMapper，类型名为同名的Po类（自定义）
  • PoMapper文件的方法名和xml文件中的操作id需要一致
  • @Param传入参数也需要和xml对应
  1. repository
    主要操作PO对象。
    在这里插入图片描述
    PO包
    将数据库表结构映射到JAVA，举例：
@Data
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)
@TableName("t_user")
public class UserPo extends BaseDatabasePo {private static final long serialVersionUID = 1L;/*** 用户昵称*/@TableField(value = "name")private String nickname;/*** 用户头像url*/@TableField(value = "avatar_url")private String avatarUrl;/*** 用户个人介绍*/@TableField(value = "description")private String introduction;/*** 用户性别*/@TableField(value = "gender")private Integer gender;}

由于对PO对象有一些公共操作，通常先在common包中写一个公共类：

@Data
@EqualsAndHashCode(exclude = {"createTime", "updateTime"})
public class BaseDatabasePo implements Serializable {/*** 主键ID*/@TableId(value = "id", type = IdType.ASSIGN_ID)protected Long id;/*** 创建时间*/@TableFieldprotected LocalDateTime createTime;/*** 更新时间*/@TableFieldprotected LocalDateTime updateTime;}

repository接口
主要包含一些对数据对象的最基本的操作方法。举例：

public interface UserRepository {public UserPo get(Long userId);public int update(UserPo po, Long userId);public Long insertOneUser(UserPo userPo);
}

repository实现类
主要是对接口类的实现。

@Repository
public class UserRepositoryImpl implements UserRepository {@Autowiredprivate UserPoMapper mapper;@Overridepublic UserPo get(Long userId) {return mapper.selectById(userId);}@Overridepublic int update(UserPo po, Long userId) {UpdateWrapper<UserPo> wrapper = new UpdateWrapper<>();wrapper.eq("id", userId);if (po.getNickname() != null)wrapper.set("nickname", po.getNickname());if (po.getAvatarUrl() != null)wrapper.set("avatar_url", po.getAvatarUrl());if (po.getIntroduction() != null)wrapper.set("introduction", po.getIntroduction());if (po.getGender() != null)wrapper.set("gender", po.getGender());return mapper.update(po, wrapper);}@Overridepublic Long insertOneUser(UserPo userPo){mapper.insert(userPo);return userPo.getId();}
}
  • 先注入PoMapper对象，用于调用各种对数据库底层的操作

3.2 application

对应应用层，主要结构如下：
在这里插入图片描述

  • common包：公共配置，主要涉及到一些exception的处理
  • 各模块包
    主要讲解各模块包，结构如下，其中dto、converter、service是必须的：
    在这里插入图片描述

3.2.1 dto

前端给后端传递的数据，举例：

@Data
public class UserInfoDto {/*** 用户id*/private Long id;/*** 用户昵称*/private String nickname;/*** 用户头像url*/private String avatarUrl;/*** 用户个人介绍*/private String introduction;/*** 用户性别*/private GenderEnum gender;}

3.2.2 converter

只用写接口，具体方法会自动实现。用来实现Po和Dto对象之间的转换。

@Mapper(componentModel = "spring")
public interface UserAppConverter {UserInfoDto toUserInfoDto(UserPo po);UserPo toUserPo(UserInfoDto dto);}

3.2.3 service

服务层的接口和实现，用来实现和数据访问层的交互。
接口

public interface UserService {public UserInfoDto getUserInfo(Long userId);public UserInfoDto updateUserInfo(UserInfoDto dto, Long userId);public Long insertOneUser(UserInfoDto userInfoDto);
}

实现类

@Service
public class UserServiceImpl implements UserService {@Autowiredprivate UserRepository userRepository;@Autowiredprivate UserAppConverter userAppConverter;/*** 根据id获取用户信息* @param userId* @return*/@Overridepublic UserInfoDto getUserInfo(Long userId) {UserPo po = userRepository.get(userId);if (po == null) {throw new NotFoundException("用户信息");}System.out.println(po);return userAppConverter.toUserInfoDto(po);}/*** 更新用户信息* @param dto* @param userId* @return* @throws NotFoundException*/@Overridepublic UserInfoDto updateUserInfo(UserInfoDto dto, Long userId){UserPo po = userAppConverter.toUserPo(dto);if (userRepository.get(userId) == null) {throw new NotFoundException("用户信息");}int succ = userRepository.update(po, userId);return userAppConverter.toUserInfoDto(userRepository.get(userId));}/*** 添加新用户* @param userInfoDto* @return*/@Overridepublic Long insertOneUser(UserInfoDto userInfoDto){UserPo userPo = userAppConverter.toUserPo(userInfoDto);UserPo userPo1 = userRepository.findByName(userPo.getNickname());if(userPo1!=null){throw new BusinessException(ExceptionType.DUPLICATE_ERROR);}Long id = userRepository.insertOneUser(userPo);return id;}}

3.3 api

控制器层，目录结构如下：
在这里插入图片描述

  • common包：公共类，包括异常捕获、权限、page验证等功能
  • 各模块包
    主要讲解模块包，结构如下：
    在这里插入图片描述

3.3.1 vo

数据视图对象，后端传给前端的数据。

@Data
public class UserInfoVo {/*** 用户id*/private String id;/*** 用户昵称*/private String nickname;/*** 用户头像url*/private String avatarUrl;/*** 用户个人介绍*/private String introduction;/*** 用户性别*/private String gender;}

3.3.2 req

对vo对象做检查。

@Data
public class UserCreateReq {/*** 用户昵称*/@Length(min = 2, max = 64, message = "昵称长度应在2-64之间")private String nickname;/*** 用户头像url*/@URL(message = "头像应当是有效的图片url")@Length(max = 255, message = "头像URL长度不能超过255")private String avatarUrl;/*** 用户个人介绍*/@Length(max = 255, message = "用户介绍长度不能超过255")private String introduction;/*** 用户性别*/@EnumStringValidate(value = GenderEnum.class, message = "不是有效的性别类型")private String gender;}

3.3.3 converter

dto和vo对象的转换。

@Mapper(componentModel = "spring")
public interface UserApiConverter{@Mapping(source = "introduction", target = "description")UserInfoVo toUserInfoVo(UserInfoDto dto);@Mapping(source = "description", target = "introduction")UserInfoDto toUserInfoDto(UserCreateReq req);}

3.3.4 controller

api的实现。

@Validated
@RestController // 既需要返回html数据又需要返回非html数据，类上使用@controller，方法上@requestcontroller或@responsebody
@Slf4j
@RequestMapping("/api/v1/user")
public class UserController {@Autowiredprivate UserService service;@Autowiredprivate UserApiConverter userApiConverter;@Autowiredprivate GenderEnumConverter genderEnumConverter;/*** 用户获得自己的基本信息** @param* @return* @methodName getOwnInfo*/// 可以不用返回CommonResullt，有包装器会拦截@RequestMapping(value = "/info/own", method = RequestMethod.GET)public UserInfoVo getOwnInfo() {return userApiConverter.toUserInfoVo(service.getUserInfo(SecurityContextHolder.getUserId()));}/*** 根据id获得用户信息** @param* @return* @methodName getUserInfo*/@RequestMapping(value = "/info/{userId}", method = RequestMethod.GET)public UserInfoVo getUserInfo(@PathVariable("userId") String userId) {return userApiConverter.toUserInfoVo(service.getUserInfo(Long.valueOf(userId)));}}

结语

以上是关于springboot的一个基本框架的梳理，具体细节方面的实现需要根据实际需求修改。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/615420.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Springboot+Vue项目-基于Java+MySQL的课程作业管理系统(附源码+演示视频+LW)

Springboot+Vue项目-基于Java+MySQL的课程作业管理系统(附源码+演示视频+LW)

大家好&#xff01;我是程序猿老A&#xff0c;感谢您阅读本文&#xff0c;欢迎一键三连哦。 &#x1f49e;当前专栏&#xff1a;Java毕业设计 精彩专栏推荐&#x1f447;&#x1f3fb;&#x1f447;&#x1f3fb;&#x1f447;&#x1f3fb; &#x1f380; Python毕业设计 &…
阅读更多...
大话设计模式——22.访问者模式（Visitor Pattern）

大话设计模式——22.访问者模式（Visitor Pattern）

简介 表示一个作用于某对象结构中的各元素的操作。它使你可以在不改变各元素的类的前提下定义作用于这些元素的新操作 UML图 应用场景 适用于数据结构相对稳定且算法易于变化的系统&#xff0c;该模式将数据结构和作用于结构上的操作之间的耦合解脱开&#xff0c;使得操作集合…
阅读更多...
什么是面向对象思想？

什么是面向对象思想？

面向对象不是一种技术&#xff0c;而是一种思想。它指导我们以什么形式组织代码&#xff0c;以什么思路解决问题。 面向对象编程&#xff0c;是一种通过对象方式&#xff0c;把现实世界映射到计算机世界的编程方法。 面向对象解决问题的思路&#xff1a;把构成问题的事物分解成…
阅读更多...
【Java探索之旅】方法的概念 定义 执行流程 实参与形参的交互

【Java探索之旅】方法的概念 定义 执行流程 实参与形参的交互

&#x1f3a5; 屿小夏 &#xff1a; 个人主页 &#x1f525;个人专栏 &#xff1a; Java编程秘籍 &#x1f304; 莫道桑榆晚&#xff0c;为霞尚满天&#xff01; 文章目录 &#x1f4d1;前言一、方法的概念及定义1.1 方法的概念1.2 方法的定义 二、方法的调用执行过程2.1 执行流…
阅读更多...
2024.4.12每日一题

2024.4.12每日一题

今天上午参加了蓝桥杯&#xff0c;只会暴力&#xff0c;还需努力学习 LeetCode 找到冠军 || 题目链接&#xff1a;2924. 找到冠军 II - 力扣&#xff08;LeetCode&#xff09; 题目描述 一场比赛中共有 n 支队伍&#xff0c;按从 0 到 n - 1 编号。每支队伍也是 有向无环图…
阅读更多...
Harmony背景图片铺满

Harmony背景图片铺满

在对页面&#xff0c;弹框设置背景时&#xff0c;需要放大全屏。 backgroundImageSize backgroundImageSize(value: SizeOptions | ImageSize) 设置组件背景图片的宽高。 卡片能力&#xff1a; 从API version 9开始&#xff0c;该接口支持在ArkTS卡片中使用。 系统能力&am…
阅读更多...
SpringMVC（一）【入门】

SpringMVC（一）【入门】

前言 学完了大数据基本组件&#xff0c;SpringMVC 也得了解了解&#xff0c;为的是之后 SpringBoot 能够快速掌握。SpringMVC 可能在大数据工作中用的不多&#xff0c;但是 SSM 毕竟是现在就业必知必会的东西了。SpringBoot 在数仓开发可能会经常用到&#xff0c;所以不废话学吧…
阅读更多...
DCI-BOX 数据中心互联扩容设备

DCI-BOX 数据中心互联扩容设备

2U DCI-BOX是针对DCI数据互联开发的一款高性能、大容量DCI平台 恒通未来2U DCI-BOX 优势&#xff1a; 随着5G网络的演进&#xff0c;人们对大数据需求越来越旺盛&#xff0c;2U DCI-BOX是针对DCI数据互联开发的一款高性能、大容量DCI平台。 1. 单机箱最大容量6.4T,单100G功耗…
阅读更多...
java中的线程通讯和线程池，Callable任务

java中的线程通讯和线程池，Callable任务

线程通讯&#xff1a; 在多线程中&#xff0c;某个线程进入“等待状态”时&#xff0c;需要某个线程来唤醒 等待方法&#xff1a; wait()//无线等待 wait(long 毫秒)//计时等待 注意&#xff0c;调用wait方法&#xff0c;会自动释放掉锁资源 处于wait状态只能由其他线程唤醒 唤…
阅读更多...
如何在宽松许可证下构建有竞争力的Milvus Cloud商业服务？

如何在宽松许可证下构建有竞争力的Milvus Cloud商业服务？

如何在宽松许可证下构建有竞争力的商业服务？ 开源公司并不一定要修改许可证作为唯一的出路，不过其挑战在于找到开源与商业化之间的平衡。 以 Zilliz 为例，我们选择将开源向量数据库 Milvus 捐赠给 Linux 基金会。在过去四年的时间里，Milvus 已经在 GitHub 上获得了超过 …
阅读更多...
uni-app的页面中使用uni-map-common的地址解析（地址转坐标）功能，一直报请求云函数出错

uni-app的页面中使用uni-map-common的地址解析（地址转坐标）功能，一直报请求云函数出错

想在uni-app的页面中使用uni-map-common的地址解析&#xff08;地址转坐标&#xff09;功能&#xff0c;怎么一直报请求云函数出错。 不看控制台啊,弄错了控制台&#xff0c;就说怎么一直没有打印出消息。 所以开始换高德地图的&#xff0c;昨天申请了两个 一开始用的第二个web…
阅读更多...
大话设计模式之桥接模式

大话设计模式之桥接模式

桥接模式是一种结构型设计模式&#xff0c;它将抽象部分与它的实现部分分离&#xff0c;使它们可以独立地变化。这种模式通过提供一个桥接接口来实现这种分离&#xff0c;使得抽象部分和实现部分可以在运行时独立地进行修改。 桥接模式主要由两个部分组成&#xff1a;抽象部分…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023