01 搭建开发环境和编写架构规则

最新推荐文章于 2023-05-21 16:59:03 发布
最新推荐文章于 2023-05-21 16:59:03 发布
阅读量276 收藏 1
点赞数
分类专栏： 项目经验 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-NC-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wangyongxun1983/article/details/108565376
版权

1、系统设计

01、开发方式

前后端分离的开发方式

02、技术架构

（1）、前端采用以Node.js为核心的Vue.js前段技术生态架构

（2）、后端采用SpringBoot2+Dubbo2.X+zookeeper+Mybatis+Redis+Mysql5.7

03、SaaS系统结构

略

04、API文档

采用Yapi、Swagger语言进行编写。

/**
 * Swagger2的接口配置
 * 
 * @author wangyongxun
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig
{
    /**
     * 创建API
     */
    @Bean
    public Docket createRestApi()
    {
        return new Docket(DocumentationType.SWAGGER_2)
                // 详细定制
                .apiInfo(apiInfo())
                .select()
                // 指定当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.xxx.xxx.xxxx.xxxx"))
                // 扫描所有 .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 添加摘要信息
     */
    private ApiInfo apiInfo()
    {
        // 用ApiInfoBuilder进行定制
        return new ApiInfoBuilder()
                .title("标题：boot管理系统_接口文档")
                .description("描述：用于管理集团旗下公司的人员信息,具体包括XXX,XXX模块...")
                .contact(new Contact(Global.getName(), null, null))
                .version("版本号:" + Global.getVersion())
                .build();
    }
}

2、搭建流程

01、父子工程

02、lombok

@Data 注解在类上

@Setter：注解在属性上，为属性提供 setting 方法

@Getter ：注解在属性上；为属性提供 getting 方法

@NoArgsConstructor ：注解在类上；为类提供一个无参的构造方法

@AllArgsConstructor ：注解在类上；为类提供一个全参的构造方法

@JsonInclude(JsonInclude.Include.NON_NULL)//非空数据不显示

03、创建控制器类返回结果

@Data
@NoArgsConstructor
public class Result {

    private boolean success;//是否成功
    private Integer code;// 返回码
    private String message;//返回信息
    private Object data;// 返回数据

    public Result(ResultCode code) {
        this.success = code.success;
        this.code = code.code;
        this.message = code.message;
    }

    public Result(ResultCode code,Object data) {
        this.success = code.success;
        this.code = code.code;
        this.message = code.message;
        this.data = data;
    }

    public Result(Integer code,String message,boolean success) {
        this.code = code;
        this.message = message;
        this.success = success;
    }

    public static Result SUCCESS(){
        return new Result(ResultCode.SUCCESS);
    }

    public static Result ERROR(){
        return new Result(ResultCode.SERVER_ERROR);
    }

    public static Result FAIL(){
        return new Result(ResultCode.FAIL);
    }
}
/**
 * 公共的返回码
 */
public enum ResultCode {

    SUCCESS(true,10000,"操作成功！"),
    //---系统错误返回码-----
    FAIL(false,10001,"操作失败"),
    UNAUTHENTICATED(false,10002,"您还未登录"),
    UNAUTHORISE(false,10003,"权限不足"),
    SERVER_ERROR(false,99999,"抱歉，系统繁忙，请稍后重试！"),

    //---用户操作返回码  2xxxx----
    MOBILEORPASSWORDERROR(false,20001,"用户名或密码错误");

    //---企业某业务01操作返回码  3xxxx----
    //---企业某业务02操作返回码  4xxxx----
    //---企业某业务03操作返回码  5xxxx----
    //---其他操作返回码----

    //操作是否成功
    boolean success;
    //操作代码
    int code;
    //提示信息
    String message;

    ResultCode(boolean success,int code, String message){
        this.success = success;
        this.code = code;
        this.message = message;
    }

    public boolean success() {
        return success;
    }

    public int code() {
        return code;
    }

    public String message() {
        return message;
    }

}

04、分布式ID生成器采用【雪花算法】略

05、公共异常处理

/**
 * 自定义异常
 */
@Getter
public class CommonException extends Exception  {

    private ResultCode resultCode;

    public CommonException(ResultCode resultCode) {
        this.resultCode = resultCode;
    }
}
/**
 * 自定义的公共异常处理器
 *      1.声明异常处理器
 *      2.对异常统一处理
 */
@ControllerAdvice
public class BaseExceptionHandler {

    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public Result error(HttpServletRequest request, HttpServletResponse response,Exception e) {
        e.printStackTrace();
        if(e.getClass() == CommonException.class) {
            //类型转型
            CommonException ce = (CommonException) e;
            Result result = new Result(ce.getResultCode());
            return result;
        }else{
            Result result = new Result(ResultCode.SERVER_ERROR);
            return result;
        }
    }

    @ExceptionHandler(value = AuthorizationException.class)
    @ResponseBody
    public Result error(HttpServletRequest request, HttpServletResponse response,AuthorizationException e) {
        return new Result(ResultCode.UNAUTHORISE);
    }
}

 

 

06、系统日志

/**
 * 操作日志记录处理
 * 
 * @author wangyongxun
 */
@Aspect
@Component
public class LogAspect
{
    private static final Logger log = LoggerFactory.getLogger(LogAspect.class);

    // 配置织入点
    @Pointcut("@annotation(com.boot.common.annotation.Log)")
    public void logPointCut()
    {
    }

    /**
     * 前置通知 用于拦截操作
     *
     * @param joinPoint 切点
     */
    @AfterReturning(pointcut = "logPointCut()")
    public void doBefore(JoinPoint joinPoint)
    {
        handleLog(joinPoint, null);
    }

    /**
     * 拦截异常操作
     * 
     * @param joinPoint
     * @param e
     */
    @AfterThrowing(value = "logPointCut()", throwing = "e")
    public void doAfter(JoinPoint joinPoint, Exception e)
    {
        handleLog(joinPoint, e);
    }

    protected void handleLog(final JoinPoint joinPoint, final Exception e)
    {
        try
        {
            // 获得注解
            Log controllerLog = getAnnotationLog(joinPoint);
            if (controllerLog == null)
            {
                return;
            }

            // 获取当前的用户
            SysUser currentUser = ShiroUtils.getSysUser();

            // *========数据库日志=========*//
            SysOperLog operLog = new SysOperLog();
            operLog.setStatus(BusinessStatus.SUCCESS.ordinal());
            // 请求的地址
            String ip = ShiroUtils.getIp();
            operLog.setOperIp(ip);

            operLog.setOperUrl(ServletUtils.getRequest().getRequestURI());
            if (currentUser != null)
            {
                operLog.setOperName(currentUser.getLoginName());
                if (StringUtils.isNotNull(currentUser.getDept())
                        && StringUtils.isNotEmpty(currentUser.getDept().getDeptName()))
                {
                    operLog.setDeptName(currentUser.getDept().getDeptName());
                }
            }

            if (e != null)
            {
                operLog.setStatus(BusinessStatus.FAIL.ordinal());
                operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
            }
            // 设置方法名称
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            operLog.setMethod(className + "." + methodName + "()");
            // 处理设置注解上的参数
            getControllerMethodDescription(controllerLog, operLog);
            // 保存数据库
            AsyncManager.me().execute(AsyncFactory.recordOper(operLog));
        }
        catch (Exception exp)
        {
            // 记录本地异常日志
            log.error("==前置通知异常==");
            log.error("异常信息:{}", exp.getMessage());
            exp.printStackTrace();
        }
    }

    /**
     * 获取注解中对方法的描述信息 用于Controller层注解
     * 
     * @param log 日志
     * @param operLog 操作日志
     * @throws Exception
     */
    public void getControllerMethodDescription(Log log, SysOperLog operLog) throws Exception
    {
        // 设置action动作
        operLog.setBusinessType(log.businessType().ordinal());
        // 设置标题
        operLog.setTitle(log.title());
        // 设置操作人类别
        operLog.setOperatorType(log.operatorType().ordinal());
        // 是否需要保存request，参数和值
        if (log.isSaveRequestData())
        {
            // 获取参数的信息，传入到数据库中。
            setRequestValue(operLog);
        }
    }

    /**
     * 获取请求的参数，放到log中
     * 
     * @param operLog 操作日志
     * @throws Exception 异常
     */
    private void setRequestValue(SysOperLog operLog) throws Exception
    {
        Map<String, String[]> map = ServletUtils.getRequest().getParameterMap();
        String params = JSON.marshal(map);
        operLog.setOperParam(StringUtils.substring(params, 0, 2000));
    }

    /**
     * 是否存在注解，如果存在就获取
     */
    private Log getAnnotationLog(JoinPoint joinPoint) throws Exception
    {
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();

        if (method != null)
        {
            return method.getAnnotation(Log.class);
        }
        return null;
    }
}

 

/**
 * 业务操作类型
 * @author wangyongxun
 *
 */
public enum BusinessType {
   
   /**
     * 其它
     */
    OTHER,

    /**
     * 新增
     */
    INSERT,

    /**
     * 修改
     */
    UPDATE,

    /**
     * 删除
     */
    DELETE,

    /**
     * 授权
     */
    GRANT,

    /**
     * 导出
     */
    EXPORT,

    /**
     * 导入
     */
    IMPORT,

    /**
     * 强退
     */
    FORCE,

    /**
     * 生成代码
     */
    GENCODE,
    
    /**
     * 清空
     */
    CLEAN,
}
/**
 * 自定义操作日志记录注解
 * @author wangyongxun
 *
 */
@Target({ ElementType.PARAMETER, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
   /**
     * 模块 
     */
    public String title() default "";

    /**
     * 功能
     */
    public BusinessType businessType() default BusinessType.OTHER;

    /**
     * 操作人类别
     */
    public OperatorType operatorType() default OperatorType.MANAGE;

    /**
     * 是否保存请求的参数
     */
    public boolean isSaveRequestData() default true;
}

 

/**
 * 操作日志记录处理
 * 
 * @author wangyongxun
 */
@Aspect
@Component
public class LogAspect
{
    private static final Logger log = LoggerFactory.getLogger(LogAspect.class);

    // 配置织入点
    @Pointcut("@annotation(com.boot.common.annotation.Log)")
    public void logPointCut()
    {
    }

    /**
     * 前置通知 用于拦截操作
     *
     * @param joinPoint 切点
     */
    @AfterReturning(pointcut = "logPointCut()")
    public void doBefore(JoinPoint joinPoint)
    {
        handleLog(joinPoint, null);
    }

    /**
     * 拦截异常操作
     * 
     * @param joinPoint
     * @param e
     */
    @AfterThrowing(value = "logPointCut()", throwing = "e")
    public void doAfter(JoinPoint joinPoint, Exception e)
    {
        handleLog(joinPoint, e);
    }

    protected void handleLog(final JoinPoint joinPoint, final Exception e)
    {
        try
        {
            // 获得注解
            Log controllerLog = getAnnotationLog(joinPoint);
            if (controllerLog == null)
            {
                return;
            }

            // 获取当前的用户
            SysUser currentUser = ShiroUtils.getSysUser();

            // *========数据库日志=========*//
            SysOperLog operLog = new SysOperLog();
            operLog.setStatus(BusinessStatus.SUCCESS.ordinal());
            // 请求的地址
            String ip = ShiroUtils.getIp();
            operLog.setOperIp(ip);

            operLog.setOperUrl(ServletUtils.getRequest().getRequestURI());
            if (currentUser != null)
            {
                operLog.setOperName(currentUser.getLoginName());
                if (StringUtils.isNotNull(currentUser.getDept())
                        && StringUtils.isNotEmpty(currentUser.getDept().getDeptName()))
                {
                    operLog.setDeptName(currentUser.getDept().getDeptName());
                }
            }

            if (e != null)
            {
                operLog.setStatus(BusinessStatus.FAIL.ordinal());
                operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
            }
            // 设置方法名称
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            operLog.setMethod(className + "." + methodName + "()");
            // 处理设置注解上的参数
            getControllerMethodDescription(controllerLog, operLog);
            // 保存数据库
            AsyncManager.me().execute(AsyncFactory.recordOper(operLog));
        }
        catch (Exception exp)
        {
            // 记录本地异常日志
            log.error("==前置通知异常==");
            log.error("异常信息:{}", exp.getMessage());
            exp.printStackTrace();
        }
    }

    /**
     * 获取注解中对方法的描述信息 用于Controller层注解
     * 
     * @param log 日志
     * @param operLog 操作日志
     * @throws Exception
     */
    public void getControllerMethodDescription(Log log, SysOperLog operLog) throws Exception
    {
        // 设置action动作
        operLog.setBusinessType(log.businessType().ordinal());
        // 设置标题
        operLog.setTitle(log.title());
        // 设置操作人类别
        operLog.setOperatorType(log.operatorType().ordinal());
        // 是否需要保存request，参数和值
        if (log.isSaveRequestData())
        {
            // 获取参数的信息，传入到数据库中。
            setRequestValue(operLog);
        }
    }

    /**
     * 获取请求的参数，放到log中
     * 
     * @param operLog 操作日志
     * @throws Exception 异常
     */
    private void setRequestValue(SysOperLog operLog) throws Exception
    {
        Map<String, String[]> map = ServletUtils.getRequest().getParameterMap();
        String params = JSON.marshal(map);
        operLog.setOperParam(StringUtils.substring(params, 0, 2000));
    }

    /**
     * 是否存在注解，如果存在就获取
     */
    private Log getAnnotationLog(JoinPoint joinPoint) throws Exception
    {
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();

        if (method != null)
        {
            return method.getAnnotation(Log.class);
        }
        return null;
    }
}

使用在方法上

@Log(title = "定时任务", businessType = BusinessType.EXPORT)

07、总体架构如图

 

 

 

 

wangyongxun1983
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Java开发环境搭建最详细最规范的手册
12-13
Java开发环境搭建最详细最规范的手册，可以直接用来供新手开发人员查阅，提高新手的培训效率。
开发环境（框架）：
Y_Mojito_的博客
10-28 101
环境
开发环境架构配置
weixin_34309543的博客
03-30 97
开发环境架构配置 作者：霍然。 这里配置的是Struts+Spring+Hibernate 开发环境。如有不托之处请高手指出，并完善。 一 所需要的软件： 1 j2sdk-1_4_2_05-windows-i586-p.exe 2 eclipse-SDK-3.1-win32.zip 3...
一套完整的开发运营环境框架
u012817905的博客
03-07 764
#镜像仓库 192.168.31.10 hub.xujinfu.com #代码出库 192.168.31.11 GitLab.xujinfu.com #Jenkins，pipeline工作流程 192.168.31.12 Jenkins.xujinfu.com #zabbix监控（可选） 192.168.31.21 zabbix.xujinfu.com #普罗米修斯监控window10.安装远程向日葵远程工具，VMware Workstation，Xshell方便24小时*...
vagrant之运维，搭建统一开发环境
weixin_33716557的博客
11-09 74
特点：通过vagrant打包环境，可以跨平台使用。意思就是在windows下可以使用ubuntu系统配置的环境使用的平台：windows+64位需要准备的工具： virtualbox:虚拟机 https://www.virtualbox.org/wiki/Downloads vagrant:下载地址 http://downloads.v...
day01-项目概述、环境搭建
最新发布
11-03
UI设计师负责根据产品原型输出界面效果图，架构师负责项目整体架构设计和技术选型，开发工程师负责代码实现，测试工程师负责编写测试用例和输出测试报告，运维工程师负责软件环境搭建和项目上线。 软件环境： 软件...
JAVA架构RocketMQ单机环境搭建pdf+架构师视频资源
01-17
1. **环境准备**：确保系统中已经安装了Java开发环境（JDK），RocketMQ依赖于Java，通常推荐使用Java 8或更高版本。 2. **下载RocketMQ**：访问RocketMQ的GitHub仓库或者官方网站，下载最新稳定版的源码或者二进制...
嵌入式linux开发概述与环境搭建.rar
03-22
接下来，我们关注“嵌入式Linux开发环境的搭建”。环境搭建是开发工作的第一步，主要包括以下步骤： 1. **选择宿主机**：宿主机是用于开发和编译代码的工作站，通常为装有Linux或Windows系统的个人电脑。 2. **...
01.搭建开发环境的引导说明1
08-08
本文将详细介绍这些内容，并概述日常开发流程以及搭建开发环境所需的步骤。 1. 嵌入式Linux开发内容： - Bootloader：Bootloader是系统启动的第一部分，类似PC中的BIOS，负责进行基本的硬件初始化，然后从存储设备...
his项目,用于开发环境需求的架构
05-08
很简单的一个demo代码，可以学习学习。
开发环境搭建指导书
03-12
提供完整的单片机开发环境搭建过程指导，包括MPLAB IDE的安装、proteus的安装、QL2006烧写器的安装等等
开发环境单节点架构图
weixin_43866043的博客
09-14 218
java程序开发环境结构_JavaEE开发教程（一）体系结构和环境配置
weixin_35040154的博客
02-25 366
软件发展状况和趋势总所周知，现在好多软件都已经从C/S模式的设计开始转向B/S模式设计。并且现在云平台的推广和HTML5的来临更是加快了转型的脚步。SOA(面向服务的架构)体系将会改变软件系统的开发和运行模式。所以从这个角度来看WEB开发的潜力是非常大的。JavaEEJavaEE只是一组以服务器为中心的企业级应用的一个规范，用于规范化和标准化以Java为开发语言的企业级软件的开发，部署，管理等。我...
开发环境搭建文档
weixin_44602460的博客
07-28 453
云管部署文档 v1.1 2021-07-12 一. 安装JDK 1. 查看系统是否携带OpenJDK, 是则卸载 1.1 查看java 版本 [root@CSSMP /]java -version # 2. 如果是以下这种结果, 则携带 openjdk version "1.8.0_262" OpenJDK Runtime Environment (build 1.8.0_262-b10) OpenJDK 64-Bit Server VM (build 25.262-b10, mixed mode)
Java入门-开发环境的搭建及基本介绍
刘树之的博客
07-20 874
Java入门-开发环境的搭建及基本介绍 一、开发环境的搭建 1.什么是JDK和JRE? JDK(Java Develpment Kit) ——Java开发工具 JRE(Java Runtime Environment) —— Java运行环境 2.JDK的安装 ​ 注意： 如果你仅仅运行java程序，只用安装JRE即可，但是你要编写Java程序，就必须安装JDK和JRE 安装路径建议用默认路径（如果不安装默认路径，在自定义路径中也不要包含中文） 安装后不会像QQ有开启软件的图标 3.配置环境变量 ​ 目
python开发环境搭建和基本用法
探索之旅
05-25 170
1、正则表达式正则表达式就是记录文本规则的代码定界符\ 见下一个字符标记为一个特殊字符 ^ 匹配输入字符串的开始位置$匹配输入字符的结束位置\b匹配一个单词的编辑，也就是指单词和空格间的位置个数/次数*匹配前面的子表达式零次或多次+匹配前面的子表达式一次或多次？匹配前面的子表达式零次或一次{n}n是一个非负整数{n,}n是一个非负整数{n,m}m和n均为非负整数，其中n&lt;=m\B匹配非单词...
Java开发架构演进篇
yinying293的博客
05-21 819
平时在写代码时，大多都在是Win10/Win7/Mac，这些系统都可以称呼为开发环境，咱们会为了更高效的开发应用程序，安装很多很多的软件，会导致操作系统不安全，稳定性降低。海量数据会导致数据库无法存储全部的内容，即便数据库可以存储海量的数据，在查询数据时，数据库的响应时极其缓慢的，在用户高并发的情况下，数据库也时无法承受住的。使用分布式架构之后，服务之间的通讯都是同步的。在Web1.0阶段，由于带宽不足，这时的项目大多是内容少，用户量也不多，甚至有一些项目不需要对外开放，对安全性和稳定性的要求是不高的。
微服架构基础设施环境平台搭建 -（三）Docker+Kubernetes集群搭建
老杜的博客
05-12 962
通过采用微服相关架构构建一套以Kubernetes+Docker为自动化运维基础平台，以微服务为服务中心，在此基础之上构建业务中台，并通过Jekins自动构建、编译、测试、发布的自动部署，形成一套完整的自动化运维、发布的快速DevOps平台。本文是展示了从手动方式在Linux上搭建Docker+Kubernets集群，其Master节点是ks-m1、ks-m2、ks-m3，Worker节点是ks-n1、ksn2。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值