JavaWeb项目编程规范

最新推荐文章于 2024-07-26 15:38:18 发布
最新推荐文章于 2024-07-26 15:38:18 发布
阅读量442 收藏 1
点赞数
分类专栏： 工作总结
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42231563/article/details/104474239
版权
工作中编码的规范，以后需要按照这样的要求去写。
  1. 编码之前首先要按照阿里巴巴的开发规范去写，如果是使用的idea要使用其插件。
  2. 在使用springmvc的情况下最好使用以下样式去定义路径：
 @RequestMapping(value = "/update/{id}", method = RequestMethod.POST)
  1. 在基于springboot或springMvc的情况下，再controller层。前端传参超过了三个就应该定义其param的对象。其属性的名称需要和他对应的实体类要一致，使用beanutils进行封装数据。举例如下：
对应的param类
package com.macro.mall.dto;

import com.macro.mall.validator.FlagValidator;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;

/**
 * 品牌传递参数
 */
@Data
public class PmsBrandParam {
    @ApiModelProperty(value = "品牌名称",required = true)
    @NotEmpty(message = "名称不能为空")
    private String name;
    @ApiModelProperty(value = "品牌首字母")
    private String firstLetter;
    @ApiModelProperty(value = "排序字段")
    @Min(value = 0, message = "排序最小为0")
    private Integer sort;
    @ApiModelProperty(value = "是否为厂家制造商")
    @FlagValidator(value = {"0","1"}, message = "厂家状态不正确")
    private Integer factoryStatus;
    @ApiModelProperty(value = "是否进行显示")
    @FlagValidator(value = {"0","1"}, message = "显示状态不正确")
    private Integer showStatus;
    @ApiModelProperty(value = "品牌logo",required = true)
    @NotEmpty(message = "品牌logo不能为空")
    private String logo;
    @ApiModelProperty(value = "品牌大图")
    private String bigPic;
    @ApiModelProperty(value = "品牌故事")
    private String brandStory;
    
}
对应的实体类
package com.macro.mall.model;

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.io.Serializable;
@Data
public class PmsBrand implements Serializable {
    private Long id;

    private String name;

    @ApiModelProperty(value = "首字母")
    private String firstLetter;

    private Integer sort;

    @ApiModelProperty(value = "是否为品牌制造商：0->不是；1->是")
    private Integer factoryStatus;

    private Integer showStatus;

    @ApiModelProperty(value = "产品数量")
    private Integer productCount;

    @ApiModelProperty(value = "产品评论数量")
    private Integer productCommentCount;

    @ApiModelProperty(value = "品牌logo")
    private String logo;

    @ApiModelProperty(value = "专区大图")
    private String bigPic;

    @ApiModelProperty(value = "品牌故事")
    private String brandStory;

    private static final long serialVersionUID = 1L;
    
}

使用的BeanUtils.copyProperties(pmsBrandParam, pmsBrand);就可以完成了对应数据的封装。
4. 在controler的返回给前端的数据时。应该去定义统一的返回对象类型以及对应的枚举，使其更加统一。示例如下：

通用返回对象(根据项目需要进行修改)
package com.macro.mall.common.api;

/**
 * 通用返回对象
 */
public class CommonResult<T> {
    private long code;
    private String message;
    private T data;

    protected CommonResult() {
    }

    protected CommonResult(long code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    /**
     * 成功返回结果
     *
     * @param data 获取的数据
     */
    public static <T> CommonResult<T> success(T data) {
        return new CommonResult<T>(ResultCode.SUCCESS.getCode(), ResultCode.SUCCESS.getMessage(), data);
    }

    /**
     * 成功返回结果
     *
     * @param data 获取的数据
     * @param  message 提示信息
     */
    public static <T> CommonResult<T> success(T data, String message) {
        return new CommonResult<T>(ResultCode.SUCCESS.getCode(), message, data);
    }

    /**
     * 失败返回结果
     * @param errorCode 错误码
     */
    public static <T> CommonResult<T> failed(IErrorCode errorCode) {
        return new CommonResult<T>(errorCode.getCode(), errorCode.getMessage(), null);
    }

    /**
     * 失败返回结果
     * @param message 提示信息
     */
    public static <T> CommonResult<T> failed(String message) {
        return new CommonResult<T>(ResultCode.FAILED.getCode(), message, null);
    }

    /**
     * 失败返回结果
     */
    public static <T> CommonResult<T> failed() {
        return failed(ResultCode.FAILED);
    }

    /**
     * 参数验证失败返回结果
     */
    public static <T> CommonResult<T> validateFailed() {
        return failed(ResultCode.VALIDATE_FAILED);
    }

    /**
     * 参数验证失败返回结果
     * @param message 提示信息
     */
    public static <T> CommonResult<T> validateFailed(String message) {
        return new CommonResult<T>(ResultCode.VALIDATE_FAILED.getCode(), message, null);
    }

    /**
     * 未登录返回结果
     */
    public static <T> CommonResult<T> unauthorized(T data) {
        return new CommonResult<T>(ResultCode.UNAUTHORIZED.getCode(), ResultCode.UNAUTHORIZED.getMessage(), data);
    }

    /**
     * 未授权返回结果
     */
    public static <T> CommonResult<T> forbidden(T data) {
        return new CommonResult<T>(ResultCode.FORBIDDEN.getCode(), ResultCode.FORBIDDEN.getMessage(), data);
    }

    public long getCode() {
        return code;
    }

    public void setCode(long code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}
枚举
package com.macro.mall.common.api;

/**
 * 枚举了一些常用API操作码
 */
public enum ResultCode implements IErrorCode {
    SUCCESS(200, "操作成功"),
    FAILED(500, "操作失败"),
    VALIDATE_FAILED(404, "参数检验失败"),
    UNAUTHORIZED(401, "暂未登录或token已经过期"),
    FORBIDDEN(403, "没有相关权限");
    private long code;
    private String message;

    private ResultCode(long code, String message) {
        this.code = code;
        this.message = message;
    }

    public long getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}
  1. 在controller进行日志输出时，应使用aop配置进行，定义统一的日志输出的对象。应当减少Logger的使用，统一的在aop的配置类进行设置，这让让业务逻辑会更加统一。示例如下：
weblog实体类
package com.macro.mall.bo;

import lombok.Data;

/**
 * Controller层的日志封装类
 */
@Data
public class WebLog {
    /**
     * 操作描述
     */
    private String description;

    /**
     * 操作用户
     */
    private String username;

    /**
     * 操作时间
     */
    private Long startTime;

    /**
     * 消耗时间
     */
    private Integer spendTime;

    /**
     * 根路径
     */
    private String basePath;

    /**
     * URI
     */
    private String uri;

    /**
     * URL
     */
    private String url;

    /**
     * 请求类型
     */
    private String method;

    /**
     * IP地址
     */
    private String ip;

    private Object parameter;

    private Object result;
}
aop配置类
package com.macro.mall.component;

import cn.hutool.core.util.StrUtil;
import cn.hutool.core.util.URLUtil;
import cn.hutool.json.JSON;
import cn.hutool.json.JSONUtil;
import com.macro.mall.bo.WebLog;
import io.swagger.annotations.ApiOperation;
import net.logstash.logback.marker.Markers;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * 统一日志处理切面
 */
@Aspect
@Component
@Order(1)
public class WebLogAspect {
    private static final Logger LOGGER = LoggerFactory.getLogger(WebLogAspect.class);

    @Pointcut("execution(public * com.macro.mall.controller.*.*(..))")
    public void webLog() {
    }

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        System.out.println("before=========");
    }

    @AfterReturning(value = "webLog()", returning = "ret")
    public void doAfterReturning(Object ret) throws Throwable {
        System.out.println("AfterReturning=====");
    }

    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("Around=====");
        long startTime = System.currentTimeMillis();
        //获取当前请求对象
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        //记录请求信息(通过Logstash传入Elasticsearch)
        WebLog webLog = new WebLog();
        Object result = joinPoint.proceed();
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();
        if (method.isAnnotationPresent(ApiOperation.class)) {
            ApiOperation log = method.getAnnotation(ApiOperation.class);
            webLog.setDescription(log.value());
        }
        long endTime = System.currentTimeMillis();
        String urlStr = request.getRequestURL().toString();
        webLog.setBasePath(StrUtil.removeSuffix(urlStr, URLUtil.url(urlStr).getPath()));
        webLog.setIp(request.getRemoteUser());
        webLog.setMethod(request.getMethod());
        webLog.setParameter(getParameter(method, joinPoint.getArgs()));
        webLog.setResult(result);
        webLog.setSpendTime((int) (endTime - startTime));
        webLog.setStartTime(startTime);
        webLog.setUri(request.getRequestURI());
        webLog.setUrl(request.getRequestURL().toString());
        Map<String,Object> logMap = new HashMap<>();
        logMap.put("url",webLog.getUrl());
        logMap.put("method",webLog.getMethod());
        logMap.put("parameter",webLog.getParameter());
        logMap.put("spendTime",webLog.getSpendTime());
        logMap.put("description",webLog.getDescription());
//        LOGGER.info("{}", JSONUtil.parse(webLog));
        LOGGER.info(Markers.appendEntries(logMap), JSONUtil.parse(webLog).toString());
        return result;
    }

    /**
     * 根据方法和传入的参数获取请求参数
     */
    private Object getParameter(Method method, Object[] args) {
        List<Object> argList = new ArrayList<>();
        Parameter[] parameters = method.getParameters();
        for (int i = 0; i < parameters.length; i++) {
            //将RequestBody注解修饰的参数作为请求参数
            RequestBody requestBody = parameters[i].getAnnotation(RequestBody.class);
            if (requestBody != null) {
                argList.add(args[i]);
            }
            //将RequestParam注解修饰的参数作为请求参数
            RequestParam requestParam = parameters[i].getAnnotation(RequestParam.class);
            if (requestParam != null) {
                Map<String, Object> map = new HashMap<>();
                String key = parameters[i].getName();
                if (!StringUtils.isEmpty(requestParam.value())) {
                    key = requestParam.value();
                }
                map.put(key, args[i]);
                argList.add(map);
            }
        }
        if (argList.size() == 0) {
            return null;
        } else if (argList.size() == 1) {
            return argList.get(0);
        } else {
            return argList;
        }
    }
}
xml配置文件
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
    <!--应用名称-->
    <property name="APP_NAME" value="mall-admin"/>
    <!--日志文件保存路径-->
    <property name="LOG_FILE_PATH" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/logs}"/>
    <contextName>${APP_NAME}</contextName>
    <!--每天记录日志到文件appender-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE_PATH}/${APP_NAME}-%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!--输出到logstash的appender-->
    <appender name="LOGSTASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
        <destination>localhost:4560</destination>
        <encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder"/>
    </appender>
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
        <appender-ref ref="LOGSTASH"/>
    </root>
</configuration>

以上总结是通过看开源项目mall商城后，根据现在所写的缺点来记录的。下个项目保证自己必要按照要求去进行更改。以上规范会进行更新。加油！

华安小书童
关注
专栏目录
Java web开发规范
09-14
为了使软件开发过程有章可循，保证软件质量，加强开发管理
项目开发规范（Java）
06-19 540
项目开发规范（Java）     关键字     JAVA、代码规范           前几天整理出来的一个JAVA的代码书写规范！项目开发规范一、目的    　　对于代码，首要要求是它必须正确，能够按照程序员的真实思想去运行；第二个的要求是代码必须清晰易懂，使别的程序员能够容易理解代码所进行的实际工作。在软件工程领域，源程序的风格统一标志着可维护性、可读性，是软件项目的一个重要组成部分。而目前
web开发规范（java版）
10-18
1. 编程规范 4 1.1. HTML页面 4 1.1.1. 页面规范 4 1.1.2. 元素id命名规范(蓝色表示常用) 4 1.1.3. 元素name命名规范 6 1.2. ASP页面 6 1.2.1. 文件命名规范 6 1.2.2. 代码分隔符 7 1.2.3. Session状态开关 7 1.2.4. ASP页面的代码规划 7 1.2.5. 代码中的空行 7 1.2.6. 使用MapPath来引用物理路径 8 1.2.7. 代码中的空格 8 1.2.8. 编程风格 8 1.2.9. 字符串连结 8 1.2.10. UCase与LCase 8 1.2.11. Trim 8 1.2.12. 局部变量与全局变量 9 1.2.13. 显示标准错误信息 9 1.3. VBScript 9 1.3.1. 命名规范 9 1.3.2. 常量命名规范 9 1.3.3. 变量命名规范 9 1.3.4. 变量作用范围 9 1.3.5. 变量与函数命名 10 1.3.6. 对象命名规范 10 1.3.7. 编程风格 10 1.4. JavaScript 10 1.4.1. 常量命名 10 1.4.2. 变量和参数命名 11 1.4.3. 函数命名 11 1.4.4. 特殊字符 11 1.5. XML编码规范 11 1.6. 程序注释 12 1.6.1. 程序头注释 12 1.6.2. 关键变量注释 12 1.6.3. 关键算法注释 12 1.6.4. 函数注释 13 1.7. 对象管理 13 1.7.1. 对象释放 13 1.7.2. 对象引用 14 2. 设计规范 14 2.1. Session对象的使用 14 2.2. Application对象的使用 14 2.3. Form and QueryString 14 2.4. New Window 14 2.4.1. window.Open 14 2.4.2. window.showModalDialog 15 2.5. 代码封装 15 2.5.1. HTC控件 15 2.5.2. Web Class 15 2.6. Project规范 15 2.6.1. 页面大小限制 15 2.6.2. 图片 16 2.6.3. 字体 16
Java Web项目代码开发规范
05-14
《Java Web项目代码开发规范》定义了项目中Java Web项目代码开发应遵循的技术规范，作为各类软件开发的指导性规范。 本文档基于开发团队需要，先期定义了相对主要的、应重点遵循的规范，今后将根据工作需要不断补充完善，增加相关细则。
java web代码规范_java web代码规范：
weixin_36185593的博客
02-19 212
每个类前要有注释，类前的注释格式是：/***类是干什么的*@author 编写该类的作者*/类中的每个方法前也要有注释：/***该方法是干什么的*@param 该方法中传入的参数*@return*//*** 目录服务类* @author X**/@Component("project.docm.catalog.CatalogService")@SuppressWarnings("all")pub...
34个经典javaweb项目实例
03-14
本资源提供了34个经典JavaWeb项目实例，旨在帮助开发者深入理解并掌握JavaWeb开发的核心技能。 1. **Servlet与JSP基础**：Servlet是JavaWeb的基础，用于处理HTTP请求，而JSP（JavaServer Pages）则是一种动态网页...
完整的javaweb项目
08-12
这个"完整的javaweb项目"包含了用户管理的核心功能，包括用户注册、登录、列表展示、信息修改以及信息删除。这些功能是任何涉及用户管理的Web应用的基础部分。 1. **用户注册**：在用户注册功能中，通常涉及到前端...
网上订餐系统 javaweb项目 （完整源码）
02-28
《网上订餐系统javaweb项目：深度解析与学习指南》 在当今信息化社会，网上订餐系统已经成为了人们生活中不可或缺的一部分。对于IT行业的初学者和开发者来说，掌握一款完整的网上订餐系统的开发技术，无疑是提升...
【狂神说JavaWeb】JavaWeb项目—SMBMS(超市管理项目)源码
03-16
【狂神说JavaWeb】JavaWeb项目—SMBMS(超市管理项目)源码是一个用于教学目的的实战项目，旨在帮助学习者理解并掌握JavaWeb开发的基本原理和技术。这个项目涵盖了从网页设计到后端服务的完整流程，是学习者实践和提升...
javaweb项目图书
12-11
JavaWeb项目图书是一个适合新手入门的学习资源，它涵盖了JavaWeb开发的基本概念和技术。这个项目以图书管理为主题，通过实际操作，帮助学习者理解和掌握如何利用JavaWeb技术来构建一个简单的在线图书管理系统。在这...
java web开发规范文档
05-09
java web开发规范文档，总结了再项目开发中应注意的事项
java Log日志规范
04-26
NULL 博文链接：https://asen0713.iteye.com/blog/2356662
Java Web 项目的开发流程指南：面向初学者的详细解析
最新发布
Mr_Zhangyuge的博客
07-26 362
在 Java Web 项目的开发过程中，遵循规范的开发流程至关重要。本文将对每个阶段进行深入解析，帮助初学者理解和掌握 Java Web 项目的开发流程，从需求分析到维护，全面覆盖项目生命周期的关键步骤。
java web开发编码规范_新型java_web编码规范.doc
weixin_39619481的博客
02-16 95
新型java_web编码规范.doc还剩36页未读，继续阅读下载文档到电脑，马上远离加班熬夜！亲，很抱歉，此页已超出免费预览范围啦！如果喜欢就下载吧，价低环保！内容要点：第 37 页 共 37 页如所有内存变量值。最少必须包括：出错时间、用户ID、出错业务功能模块名称、引起出错的外部接口返回代码、出错所在代码包/类/方法名称(按调用层次逐层列出)及语句行号(不包括无源代码的API调用)。每条日志需...
java web开发常见规范
qq_41966009的博客
05-29 631
1.包名规范 Package 名 说明 1 Entity 存放实体类，与数据库表一一对应 2 config 存放配置类，如存放redis配置存放系统常量类 3 constans 存放系统常量类 4 bean 此处只存放ResponseBean，封装后台响应 5 Controller 控制器类，控制层，接受http请求，返回json数据 6 Mapper Dao类，存放数据库单标操作 7 Service 服务类，包含service接口和具体实现类 8 Enums
JavaWeb开发规范
qq_36821517的博客
12-24 199
以下的建议将帮助你更有效地使用本文所描述的 Java 编程标准： ******************************************************* 当你写代码时就应该遵守标准，而不应是一个事后的想法。 加了注释的代码不仅在你写程序时，而且在你写完程序时，都更容易理解。 在程序开发阶段和维护阶段，一致性地命名成员函数和字段都使工作更加容易。 在开发和维护阶段，...
java web开发规范
kangxi4xjp的博客
05-07 185
2 设计规范 2.1 系统设计规范 当有需求 变化的时候，开发经理必须遵守一个顺序，第一先修改概要设计、设计设计，数据库设计等接着再修改代码的原则； 对于每一 次修改，都必须编写 changelog ； 系统的设 计文件需要放到版本控制文件当中，以便对不同的版本进行控制； 2.2 数据库设计规范 数据库的 设计必须放到 PowerDesinger 的 Rep...
JavaWeb入门必备JavaEE规范
编程火箭车（Coding Rocket）专注编程领域
04-28 2090
对于学习 Java 的同学，大都是 Web 方向的。
Java代码编写规范
Java Web 开发教程
09-28 392
原文出处：http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html，译文出处：http://morningspace.51.net/，moyingzz@etang.com 1 介绍(Introduction) 1.1 为什么要有编码规范(Why Have Code Conventions) 编码规范对于程序员而言尤为重要，有以下...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值