Java应用结构规范[通俗易懂]

Java应用结构规范[通俗易懂]简介:在Java程序开发中,命名和应用分层无疑是广大后端同胞的两大“痛点”,本文提供一种基于领域模型的轻量级应用分层结构设计,供大家参考。下面按分层结构、分层明细、调用关系、各层规范和通用代码工具展开介绍。作者|阿卓来源|阿里技术公众号序言在Java程序开发中,命名和应用分层无疑是广大后端同胞的两大“痛点”,本文提供一种基于领域模型的轻量级应用分层结构设计,供大家参考。下面按分层结构、分层明细、调用关系、各层规范和通用代码工具展开介绍。一分层结构web(前端请求层)

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

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

Java应用结构规范[通俗易懂]

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

序言

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

一 分层结构

Java应用结构规范[通俗易懂]

  • web(前端请求层)

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

  • biz(业务层)

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

  • dal(数据层)

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

  • client(外部请求层)

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

  • common(外部公共层)

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

  • facade(外观层)

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

二 分层明细

web(前端请求层)

Java应用结构规范[通俗易懂]

biz(业务层)

Java应用结构规范[通俗易懂]

dal(数据层)

Java应用结构规范[通俗易懂]

client(外部请求层)

Java应用结构规范[通俗易懂]

common(外部公共层)

Java应用结构规范[通俗易懂]

facade(外观层)

Java应用结构规范[通俗易懂]

start(启动类)

qatest(测试类)

三 调用关系

Java应用结构规范[通俗易懂]

注意点:

  • 服务和服务直接可以互相调用;
  • 服务可以调用多个域的域能力;
  • 域能力是封装好的最小颗粒度的能力,不可互相调用;
  • 查询服务直接调用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();
    }

}

原文链接

本文为阿里云原创内容,未经允许不得转载。 

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/170752.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)
blank

相关推荐

  • gerrit用法

    gerrit用法

  • 运行时异常与非运行时异常的区别

    运行时异常与非运行时异常的区别

  • Tornado(cookie、XSRF、用户验证)

    Tornado(cookie、XSRF、用户验证)——————–Cookie操作——————–1、设置Cookie1、set_cookie(name,value,domain=None,expires=None,path=”/”)2、参数说明:1、name:cookie名2、value:cookie值3、domain:提交cooki…

  • 十大经典排序算法详解(三)-堆排序,计数排序,桶排序,基数排序[通俗易懂]

    十大经典排序算法详解(三)-堆排序,计数排序,桶排序,基数排序[通俗易懂]十大经典排序算法-堆排序,计数排序,桶排序,基数排序1-堆排序算法思想:算法图解:示例代码:在这里插入代码片复杂度分析:2-计数排序算法思想:算法图解:示例代码:在这里插入代码片复杂度分析:3-桶排序算法思想:算法图解:示例代码:在这里插入代码片复杂度分析:4-基数排序算法思想:算法图解:示例代码:在这里插入代码片复杂度分析:…

  • csv文件格式说明[通俗易懂]

    csv文件格式说明[通俗易懂]csv文件应用很广泛,历史也很悠久。有很多种类型的csv格式,常用的是rfc4180定义的格式。csv文件包含一行或多行记录,每行记录中包含一个或多个字段。记录与记录之间使用换行符分隔,最后一个记

  • PP图和QQ图

    一.QQ图分位数图示法(QuantileQuantilePlot,简称Q-Q图)统计学里Q-Q图(Q代表分位数)是一个概率图,用图形的方式比较两个概率分布,把他们的两个分位数放在一起比较。首先选好分位数间隔。图上的点(x,y)反映出其中一个第二个分布(y坐标)的分位数和与之对应的第一分布(x坐标)的相同分位数。因此,这条线是一条以分位数间隔为参数的曲线。如果两个分布相似,则该Q-Q图…

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号