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

Java应用结构规范

2022-03-14 1540
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
日志服务 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
目录
相关文章
vohelon
|
2月前
|
人工智能 安全 Java
Java和Python在企业中的应用情况
Java和Python在企业中的应用情况
vohelon
62 7
栈江湖
|
13天前
|
安全 算法 Java
Java CAS原理和应用场景大揭秘：你掌握了吗？
CAS（Compare and Swap）是一种乐观锁机制，通过硬件指令实现原子操作，确保多线程环境下对共享变量的安全访问。它避免了传统互斥锁的性能开销和线程阻塞问题。CAS操作包含三个步骤：获取期望值、比较当前值与期望值是否相等、若相等则更新为新值。CAS广泛应用于高并发场景，如数据库事务、分布式锁、无锁数据结构等，但需注意ABA问题。Java中常用`java.util.concurrent.atomic`包下的类支持CAS操作。
栈江湖
44 2
Java开发者
|
2月前
|
缓存 Java 开发者
Java多线程并发编程：同步机制与实践应用
本文深入探讨Java多线程中的同步机制，分析了多线程并发带来的数据不一致等问题，详细介绍了`synchronized`关键字、`ReentrantLock`显式锁及`ReentrantReadWriteLock`读写锁的应用，结合代码示例展示了如何有效解决竞态条件，提升程序性能与稳定性。
Java开发者
163 6
最好zzz
|
1月前
|
监控 Java 数据库连接
Java线程管理：守护线程与用户线程的区分与应用
在Java多线程编程中，线程可以分为守护线程（Daemon Thread）和用户线程（User Thread）。这两种线程在行为和用途上有着明显的区别，了解它们的差异对于编写高效、稳定的并发程序至关重要。
最好zzz
37 2
mzlogin
|
2月前
|
JSON Java 程序员
Java｜如何用一个统一结构接收成员名称不固定的数据
本文介绍了一种 Java 中如何用一个统一结构接收成员名称不固定的数据的方法。
mzlogin
27 3
蓝易云
|
2月前
|
安全 IDE Java
Java常见规范及易忘点
遵循Java编程规范和注意易忘点是提高代码质量和可维护性的关键。通过规范的命名、格式、注释和合理的代码组织，可以让代码更加清晰和易于维护。同时，注意空指针检查、线程安全、集合框架和字符串操作等常见易忘点，可以减少程序错误，提高运行效率。结合单一职责原则、面向接口编程和合理的异常处理，能够编写出高质量的Java代码。希望本文能够帮助Java开发者提升编码水平，写出更高效、更可靠的代码。
蓝易云
30 2
喜欢猪猪
|
2月前
|
关系型数据库 MySQL Java
MySQL索引优化与Java应用实践
【11月更文挑战第25天】在大数据量和高并发的业务场景下，MySQL数据库的索引优化是提升查询性能的关键。本文将深入探讨MySQL索引的多种类型、优化策略及其在Java应用中的实践，通过历史背景、业务场景、底层原理的介绍，并结合Java示例代码，帮助Java架构师更好地理解并应用这些技术。
喜欢猪猪
57 2
游客762btuqu5wybw666
|
2月前
|
存储 安全 Java
Java多线程编程中的并发容器：深入解析与实战应用####
在本文中，我们将探讨Java多线程编程中的一个核心话题——并发容器。不同于传统单一线程环境下的数据结构，并发容器专为多线程场景设计，确保数据访问的线程安全性和高效性。我们将从基础概念出发，逐步深入到`java.util.concurrent`包下的核心并发容器实现，如`ConcurrentHashMap`、`CopyOnWriteArrayList`以及`BlockingQueue`等，通过实例代码演示其使用方法，并分析它们背后的设计原理与适用场景。无论你是Java并发编程的初学者还是希望深化理解的开发者，本文都将为你提供有价值的见解与实践指导。 --- ####
游客762btuqu5wybw666
51 3
大数据文摘
|
10天前
|
Java
Java—多线程实现生产消费者
本文介绍了多线程实现生产消费者模式的三个版本。Version1包含四个类：`Producer`（生产者）、`Consumer`（消费者）、`Resource`（公共资源）和`TestMain`（测试类）。通过`synchronized`和`wait/notify`机制控制线程同步，但存在多个生产者或消费者时可能出现多次生产和消费的问题。 Version2将`if`改为`while`，解决了多次生产和消费的问题，但仍可能因`notify()`随机唤醒线程而导致死锁。因此，引入了`notifyAll()`来唤醒所有等待线程，但这会带来性能问题。
大数据文摘
40 1
Java—多线程实现生产消费者
2G冲浪词条
|
12天前
|
安全 Java Kotlin
Java多线程——synchronized、volatile 保障可见性
Java多线程中，`synchronized` 和 `volatile` 关键字用于保障可见性。`synchronized` 保证原子性、可见性和有序性，通过锁机制确保线程安全；`volatile` 仅保证可见性和有序性，不保证原子性。代码示例展示了如何使用 `synchronized` 和 `volatile` 解决主线程无法感知子线程修改共享变量的问题。总结：`volatile` 确保不同线程对共享变量操作的可见性，使一个线程修改后，其他线程能立即看到最新值。
2G冲浪词条
32 7

阿里技术

热门文章

最新文章

  • 1
    Java volatile关键字：你真的懂了吗？
  • 2
    java小工具util系列2：字符串工具
  • 3
    Java爬虫：数据采集的强大工具
  • 4
    Java多线程并发编程：同步机制与实践应用
  • 5
    Java中的异常处理：从基础到高级
  • 6
    深入理解Java异常处理机制
  • 7
    Liunx部署java项目Tomcat、Redis、Mysql教程
  • 8
    Java爬虫：深入解析商品详情的利器
  • 9
    java实现从HDFS上下载文件及文件夹的功能，以流形式输出，便于用户自定义保存任何路径下
  • 10
    Java 异常处理：机制、策略与最佳实践
  • 1
    【Java开发指南 | 第三十一篇】Java 包(package)
    88
  • 2
    【Java开发指南 | 第二十九篇】Java接口
    52
  • 3
    【Java开发指南 | 第二十八篇】Java封装
    62
  • 4
    【Java开发指南 | 第二十六篇】Java多态
    42
  • 5
    【Java开发指南 | 第二十四篇】Java继承
    62
  • 6
    【Java开发指南 | 第九篇】访问实例变量和方法、继承、接口
    61
  • 7
    【Java开发指南 | 第八篇】Java变量、构造方法、创建对象
    95
  • 8
    Java Stream API详解与使用
    102
  • 9
    Java医院绩效考核系统源码B/S+avue+MySQL助力医院实现精细化管理
    86
  • 10
    《手把手教你》系列技巧篇（四十三）-java+ selenium自动化测试-处理https 安全问题或者非信任站点-上篇（详解教程）
    141

    • 相关课程

    更多
  • 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面向对象编写网络通信程序应用
  • 手动部署Java Web环境（Alibaba Cloud Linux 2）
  • 搭建Java Web开发环境（Anolis OS）
  • RocketMQ中使用Java客户端发送消息和消费的应用
    • 下一篇
    阿里云无影云电脑免费试用，最长可试用3个月