AI 助理
备案控制台
开发者社区 阿里技术 文章 正文

Java应用结构规范

2022-03-14 1526
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
日志服务 SLS，月写入数据量 50GB 1个月
简介： 在Java程序开发中，命名和应用分层无疑是广大后端同胞的两大“痛点”，本文提供一种基于领域模型的轻量级应用分层结构设计，供大家参考。下面按分层结构、分层明细、调用关系、各层规范和通用代码工具展开介绍。

image.png

作者 | 阿卓
来源 | 阿里技术公众号

序言

在Java程序开发中，命名和应用分层无疑是广大后端同胞的两大“痛点”，本文提供一种基于领域模型的轻量级应用分层结构设计，供大家参考。下面按分层结构、分层明细、调用关系、各层规范和通用代码工具展开介绍。

一 分层结构

image.png

  • web（前端请求层）

通过调用业务层服务，处理前端的请求。

  • biz（业务层）

提供封装好的能力，并通过对能力进行组装、编排，进行业务逻辑处理。

  • dal（数据层）

对底层数据源进行增删改查操作。

  • client（外部请求层）

定义暴露给其他应用的接口。

  • common（外部公共层）

定义暴露给外部的公共类。

  • facade（外观层）

通过调用业务层服务，处理外部应用的请求。

二 分层明细

web（前端请求层）

image.png

biz（业务层）

image.png

dal（数据层）

image.png

client（外部请求层）

image.png

common（外部公共层）

image.png

facade（外观层）

image.png

start（启动类）

qatest（测试类）

三 调用关系

image.png

注意点：

  • 服务和服务直接可以互相调用；
  • 服务可以调用多个域的域能力；
  • 域能力是封装好的最小颗粒度的能力，不可互相调用；
  • 查询服务直接调用manager，不调用域能力；

四 各层规范

web（前端请求层）

  • 定义统一的异常处理切面：处理业务异常和其他运行时异常；

biz（业务层）

  • 内部服务不做异常处理和返回result封装类，异常都抛给web层和facade层处理。
  • 查询服务和其他服务区分开，单独放在一个包中；
  • 能力唯一对应一个域，且是封装好的最小颗粒度的能力。
  • 外部服务要在remote中做好异常处理和封装；
  • 业务层中的common类为仅在应用内部使用的公共类；

dal（数据层）

  • mapper要按不同类型的数据源分开存放，如adb和xdb。

common（外部公共层）

  • common只存放暴露给外部的实体类、常量和枚举；
  • 暴露给外部的dto只保留外部必要的字段，其他字段如feature等不可存在。

facade（外观层）

  • 定义统一的异常处理切面：处理业务异常和其他运行时异常；
  • facade层的hsf实现类只做简单的参数校验和转化，不要写业务逻辑。

五 通用代码和工具

web（前端请求层）

  • 统一异常处理切面
@RestControllerAdvice
public class RestExceptionHandler {


    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler(Exception.class)
    public Result system(HttpServletRequest req, Exception e) {
        AllLoggers.EXCEPTION.error("RestExceptionHandler.system|servlet:{}|method:{}|code:{}|msg:{}",
                req.getServletPath(),req.getMethod(), e.getMessage(), e);
        return Result.error(ResultCode.BASE.SYSTEM_ERROR);
    }

    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler(BusinessException.class)
    public Result business(HttpServletRequest req, BusinessException e) {
        AllLoggers.EXCEPTION.error("RestExceptionHandler.business|servlet:{}|method:{}|code:{}|msg:{}",
                req.getServletPath(),req.getMethod(), e.getMessage(), e);
        return Result.error(e.getErrorCode(), e.getErrorMessage());
    }
}

biz（业务层）

  • 统一日志打印工具类
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public interface AllLoggers {

    /**
     * 应用日志
     */
    Logger APPLICATION = LoggerFactory.getLogger("APPLICATION");

    /**
     * 异常日志
     */
    Logger EXCEPTION = LoggerFactory.getLogger("EXCEPTION");

    /**
     * 业务日志
     */
    Logger BIZ = LoggerFactory.getLogger("BIZ");

    /**
     * hsf日志
     */
    Logger HSF = LoggerFactory.getLogger("HSF");

    /**
     * 入口日志
     */
    Logger MTOP = LoggerFactory.getLogger("MTOP");

}


< ?xml version="1.0" encoding="UTF-8"?>
< configuration>
    < !-- https://github.com/spring-projects/spring-boot/blob/v1.5.13.RELEASE/spring-boot/src/main/resources/org/springframework/boot/logging/logback/defaults.xml -->
    < include resource="org/springframework/boot/logging/logback/defaults.xml" />

    < property resource="application.properties">< /property>
    < property name="APP_NAME" value="toms" />
    < property name="LOG_PATH" value="${user.home}/${APP_NAME}/logs" />
    < property name="LOG_FILE" value="${LOG_PATH}/toms-root.log" />

    < appender name="APPLICATION"
        class="ch.qos.logback.core.rolling.RollingFileAppender">
        < file>${LOG_FILE}/toms-root.log< /file>
        < encoder>
            < pattern>< ![CDATA[%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%level] [traceId:%X{EAGLEEYE_TRACE_ID}] [%class:%line] - %m %n ]]> < /pattern>
            < charset>UTF-8< /charset>
        < /encoder>
        < rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            < fileNamePattern>${LOG_PATH}/logs_saved/toms-root.%d{yyyy-MM-dd}.%i.log< /fileNamePattern>
            < maxHistory>5< /maxHistory>
            < maxFileSize>1GB< /maxFileSize>
            < totalSizeCap>20GB< /totalSizeCap>
        < /rollingPolicy>
    < /appender>

    < appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        < encoder>
            < pattern>${CONSOLE_LOG_PATTERN}< /pattern>
            < charset>utf8< /charset>
        < /encoder>
    < /appender>

    < !--业务日志-->
    < appender name="TOMS-BIZ-APPENDER"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        < File>${LOG_PATH}/toms-biz.log< /File>
        < rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            < FileNamePattern>${LOG_PATH}/logs_saved/toms-biz.%d{yyyy-MM-dd}.%i.log< /FileNamePattern>
            < maxHistory>5< /maxHistory>
            < maxFileSize>2GB< /maxFileSize>
            < totalSizeCap>20GB< /totalSizeCap>
        < /rollingPolicy>
        < encoder>
            < pattern>< ![CDATA[%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%level] [traceId:%X{EAGLEEYE_TRACE_ID}] [%class:%line] - %m %n ]]> < /pattern>
            < charset>UTF-8< /charset>
        < /encoder>
    < /appender>

    < !--hsf日志-->
    < appender name="TOMS-HSF-APPENDER"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        < File>${LOG_PATH}/toms-hsf.log< /File>
        < rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            < FileNamePattern>${LOG_PATH}/logs_saved/toms-hsf.%d{yyyy-MM-dd}.%i.log< /FileNamePattern>
            < maxHistory>5< /maxHistory>
            < maxFileSize>2GB< /maxFileSize>
            < totalSizeCap>20GB< /totalSizeCap>
        < /rollingPolicy>
        < encoder>
            < pattern>< ![CDATA[%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%level] [traceId:%X{EAGLEEYE_TRACE_ID}] [%class:%line] - %m %n ]]> </pattern>
            < charset>UTF-8< /charset>
        < /encoder>
    < /appender>

    < !-- 通用错误日志 -->
    < appender name="TOMS-ERROR-APPENDER"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        < File>${LOG_PATH}/toms-error.log< /File>
        < filter class="ch.qos.logback.classic.filter.LevelFilter">
            < level>ERROR< /level>
            < onMatch>ACCEPT</onMatch>
            < onMismatch>DENY</onMismatch>
        < /filter>
        < rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            < FileNamePattern>${LOG_PATH}/logs_saved/toms-error.%d{yyyy-MM-dd}.%i.log< /FileNamePattern>
            < maxHistory>5< /maxHistory>
            < maxFileSize>2GB< /maxFileSize>
            < totalSizeCap>10GB< /totalSizeCap>
        < /rollingPolicy>
        < encoder>
            < pattern>< ![CDATA[%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%level] [traceId:%X{EAGLEEYE_TRACE_ID}] [%class:%line] - %m %n ]]> < /pattern>
            < charset>UTF-8< /charset>
        < /encoder>
    < /appender>

    < !-- 异常日志 -->
    < appender name="TOMS-EXCEPTION-APPENDER"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        < File>${LOG_PATH}/toms-exception.log< /File>
        < rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            < FileNamePattern>${LOG_PATH}/logs_saved/toms-exception.%d{yyyy-MM-dd}.log< /FileNamePattern>
            < maxHistory>5< /maxHistory>
        < /rollingPolicy>
        < encoder>
            < pattern><![CDATA[%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%level] [traceId:%X{EAGLEEYE_TRACE_ID}] [%class:%line] - %m %n ]]> < /pattern>
            < charset>UTF-8< /charset>
        < /encoder>
    < /appender>

    < logger name="HSF" level="${logback.info.level}" additivity="false">
        < appender-ref ref="TOMS-HSF-APPENDER"/>
    < /logger>

    < logger name="BIZ" level="${logback.info.level}" additivity="false">
        < appender-ref ref="TOMS-BIZ-APPENDER"/>
        < appender-ref ref="TOMS-ERROR-APPENDER"/>
    < /logger>

    < logger name="EXCEPTION" level="${logback.info.level}" additivity="false">
        < appender-ref ref="TOMS-EXCEPTION-APPENDER"/>
        <appender-ref ref="TOMS-ERROR-APPENDER"/>
    < /logger>

    < root level="INFO">
        < appender-ref ref="CONSOLE" />
    < /root>
< /configuration>
  • 单位转化工具类
public class UnitConvertUtils {

    /**
     * 米和千米的进率
     */
    public static final double RATE_OF_METRE_AND_KILOMETRE = 1000d;
    public static final int INT_RATE_OF_METRE_AND_KILOMETRE = 1000;

    /**
     * 分和元的进率
     */
    public static final double RATE_OF_FEN_AND_YUAN = 100d;

    /**
     * 立方厘米和立方米的进率
     */
    public static final double INT_RATE_OF_CM3_AND_M3 = 1000000d;

    /**
     * 米转千米
     *
     * @param toConvert
     * @return 异常返回null
     */
    public static Double convertMetre2Kilometre(Long toConvert) {
        if (toConvert == null) {
            return null;
        }
        return toConvert / RATE_OF_METRE_AND_KILOMETRE;
    }

    /**
     * 千米转米
     *
     * @param toConvert
     * @return 异常返回null
     */
    public static Long convertKilometre2Metre(Double toConvert) {
        if (toConvert == null) {
            return null;
        }

        BigDecimal bigDecimal = BigDecimal.valueOf(toConvert);
        BigDecimal factorBigDecimal = BigDecimal.valueOf(RATE_OF_METRE_AND_KILOMETRE);

        return bigDecimal.multiply(factorBigDecimal).longValue();
    }

    /**
     * 元转分
     *
     * @param toConvert
     * @return 异常返回null
     */
    public static Long convertYuan2Fen(Double toConvert) {
        if (toConvert == null) {
            return null;
        }

        BigDecimal bigDecimal = BigDecimal.valueOf(toConvert);
        BigDecimal factorBigDecimal = BigDecimal.valueOf(RATE_OF_FEN_AND_YUAN);

        return bigDecimal.multiply(factorBigDecimal).longValue();
    }

    /**
     * 元转分
     *
     * @param toConvert
     * @return 异常返回null
     */
    public static Long convertYuan2Fen(String toConvert) {
        if (toConvert == null) {
            return null;
        }

        BigDecimal bigDecimal = BigDecimal.valueOf(ConvertUtils.convertString2Double(toConvert));
        BigDecimal factorBigDecimal = BigDecimal.valueOf(RATE_OF_FEN_AND_YUAN);

        return bigDecimal.multiply(factorBigDecimal).longValue();
    }

    /**
     * 分转元
     *
     * @param price
     * @return
     */
    public static String convertFen2Yuan(Long price) {
        if (price == null) {
            return null;
        }

        return BigDecimal.valueOf(price).divide(new BigDecimal(RATE_OF_FEN_AND_YUAN)).toString();
    }

    /**
     * 里程米转换为千米
     *
     * @param distance
     * @return
     */
    public static Double meter2Kilometer(Long distance) {
        if (distance == null) {
            return null;
        }

        BigDecimal meter = BigDecimal.valueOf(distance);
        BigDecimal kilometer = meter.divide(new BigDecimal(INT_RATE_OF_METRE_AND_KILOMETRE));
        return kilometer.doubleValue();
    }

    /**
     * 立方厘米转立方米
     *
     * @param volume
     * @return
     */
    public static String convertCm32M3(Long volume) {
        if (volume == null) {
            return null;
        }

        return BigDecimal.valueOf(volume).divide(new BigDecimal(INT_RATE_OF_CM3_AND_M3)).toString();
    }

}

开发者评测局特别节目暨无影评测大赛颁奖典礼


重磅来袭！

阿里云开发者社区重磅评测栏目《开发者评测局》暨无影评测大赛颁奖典礼重磅开播。CSDN TOP 1 博主“处女座程序猿”、清华大学教授卓晴，苏宁消金安全运维总经理顾黄亮等来自开发者、高校、企业的参赛代表嘉宾与无影内部团队展开了深度圆桌论坛，共话“云时代云办公”。

image.png

文章标签：
云数据库 ClickHouse
日志服务
Java
前端开发
应用服务中间件
运维
HSF
程序员
安全
开发者
关键词：
Java应用
Java结构
Java规范
Java应用结构
Java应用规范
开发者小助手_LS
目录
相关文章
艾利克斯冰
|
11天前
|
JSON Java Apache
非常实用的Http应用框架，杜绝Java Http 接口对接繁琐编程
UniHttp 是一个声明式的 HTTP 接口对接框架，帮助开发者快速对接第三方 HTTP 接口。通过 @HttpApi 注解定义接口，使用 @GetHttpInterface 和 @PostHttpInterface 等注解配置请求方法和参数。支持自定义代理逻辑、全局请求参数、错误处理和连接池配置，提高代码的内聚性和可读性。
艾利克斯冰
55 3
阿里云开发者
|
20天前
|
人工智能 前端开发 Java
基于开源框架Spring AI Alibaba快速构建Java应用
本文旨在帮助开发者快速掌握并应用 Spring AI Alibaba，提升基于 Java 的大模型应用开发效率和安全性。
阿里云开发者
118 5
基于开源框架Spring AI Alibaba快速构建Java应用
土木林森
|
13天前
|
SQL Java 数据库连接
从理论到实践：Hibernate与JPA在Java项目中的实际应用
本文介绍了Java持久层框架Hibernate和JPA的基本概念及其在具体项目中的应用。通过一个在线书店系统的实例，展示了如何使用@Entity注解定义实体类、通过Spring Data JPA定义仓库接口、在服务层调用方法进行数据库操作，以及使用JPQL编写自定义查询和管理事务。这些技术不仅简化了数据库操作，还显著提升了开发效率。
土木林森
28 3
众所周知
|
23天前
|
SQL 监控 Java
技术前沿：Java连接池技术的最新发展与应用
本文探讨了Java连接池技术的最新发展与应用，包括高性能与低延迟、智能化管理和监控、扩展性与兼容性等方面。同时，结合最佳实践，介绍了如何选择合适的连接池库、合理配置参数、使用监控工具及优化数据库操作，为开发者提供了一份详尽的技术指南。
众所周知
30 7
东方睿赢
|
21天前
|
SQL Java 数据库连接
在Java应用中，数据库访问常成为性能瓶颈。连接池技术通过预建立并复用数据库连接，有效减少连接开销，提升访问效率
在Java应用中，数据库访问常成为性能瓶颈。连接池技术通过预建立并复用数据库连接，有效减少连接开销，提升访问效率。本文介绍了连接池的工作原理、优势及实现方法，并提供了HikariCP的示例代码。
东方睿赢
35 3
东方睿赢
|
21天前
|
存储 Java 关系型数据库
在Java开发中，数据库连接是应用与数据交互的关键环节。本文通过案例分析，深入探讨Java连接池的原理与最佳实践
在Java开发中，数据库连接是应用与数据交互的关键环节。本文通过案例分析，深入探讨Java连接池的原理与最佳实践，包括连接创建、分配、复用和释放等操作，并通过电商应用实例展示了如何选择合适的连接池库（如HikariCP）和配置参数，实现高效、稳定的数据库连接管理。
东方睿赢
40 2
蓝易云
|
23天前
|
缓存 Java 数据库连接
Hibernate：Java持久层框架的高效应用
通过上述步骤，可以在Java项目中高效应用Hibernate框架，实现对关系数据库的透明持久化管理。Hibernate提供的强大功能和灵活配置，使得开发者能够专注于业务逻辑的实现，而不必过多关注底层数据库操作。
蓝易云
13 1
xaubllxwtvaqiu
|
SQL 存储 Java
Java 应用与数据库的关系| 学习笔记
快速学习 Java 应用与数据库的关系。
xaubllxwtvaqiu
204 0
Java 应用与数据库的关系| 学习笔记
学堂小助手
|
SQL 存储 Java
Java 应用与数据库的关系| 学习笔记
快速学习 Java 应用与数据库的关系。
学堂小助手
191 0
Java 应用与数据库的关系| 学习笔记
开发者小达人
|
SQL 存储 关系型数据库
Java应用与数据库的关系|学习笔记
快速学习Java应用与数据库的关系
开发者小达人
176 0
Java应用与数据库的关系|学习笔记

阿里技术

热门文章

最新文章

  • 1
    【Java】留下没有基础眼泪的面试题
  • 2
    Java -- JDBC 学习--通过 ResultSet 执行查询操作
  • 3
    How to programmatically new a java class which implements sepecified interface in eclipse plugin development
  • 4
    java安全编码规范
  • 5
    从 Java 开始进入 Kotlin的世界： From Java to Kotlin: JKotlinor
  • 6
    关于安装多个版本jdk之后java -version不正确的问题
  • 7
    Elasticsearch Java API(九)--删除文档的field以及field的属性
  • 8
    Java基础之004-面向对象
  • 9
    [Java][Android][Process] 暴力的服务能够解决一切，暴力的方式运行命令行语句
  • 10
    java-subString方法易导致内存溢出
  • 1
    java接口防爬虫
    132
  • 2
    day14：Java零基础-条件运算符
    43
  • 3
    Java并发编程中的锁机制与性能优化
    53
  • 4
    深入理解Java虚拟机：垃圾收集机制的演变与最佳实践
    53
  • 5
    《手把手教你》系列基础篇（九十五）-java+ selenium自动化测试-框架之设计篇-java实现自定义日志输出（详解教程）
    297
  • 6
    Java并发编程之线程池深度解析
    65
  • 7
    Java中的并发编程：从基础到高级
    68
  • 8
    Java并发编程中的线程安全性与性能优化
    57
  • 9
    《手把手教你》系列基础篇（九十四）-java+ selenium自动化测试-框架设计基础-POM设计模式实现-下篇（详解教程）
    50
  • 10
    Spring Boot框架在java领域的优势
    78

    • 相关课程

    更多
  • Java面试疑难点解析 - 面试技巧及语言基础
  • Java面试疑难点解析 - Java Web开发
  • Java面试疑难点解析 - 系统架构及项目设计
  • Java编程入门
  • Java面向对象编程
  • Java高级编程

    • 相关电子书

    更多
  • Spring Cloud Alibaba - 重新定义 Java Cloud-Native
  • The Reactive Cloud Native Arch
  • JAVA开发手册1.5.0

    • 相关实验场景

    更多
  • 语言入门-1：环境构建
  • 阿里云平台上进行Java程序的编译与运行
  • 使用Java面向对象编写网络通信程序应用
  • Python网络通信程序典型应用
  • 手动部署Java Web环境（Alibaba Cloud Linux 2）
  • 搭建Java Web开发环境（Anolis OS）
    • 下一篇
    手把手教你白嫖阿里云服务器(免费领服务器)