java开发规范(刚入行同学必看)

2024-04-03 20:28

本文主要是介绍java开发规范(刚入行同学必看),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

企业级后端Java开发规范主要包括以下几个方面:

  1. 代码风格和命名规范:

    • 使用驼峰命名法,类名首字母大写,变量和方法名首字母小写;
    • 使用有意义且易于理解的命名,避免使用缩写;
    • 每个类文件只包含一个类,并且文件名与类名保持一致;
    • 使用制表符或四个空格进行缩进;
    • 使用大括号对代码块进行包裹,左大括号要另起一行,右大括号要与代码块的起始位置对齐;
    • 避免使用魔法数字,使用常量来代替。
  2. 注释规范:

    • 使用Javadoc格式的注释来解释类、方法和字段的功能,参数说明和返回值说明;
    • 注释要清晰明了,语法正确,避免使用废弃不用的注释。
  3. 异常处理规范:

    • 每个方法都要处理可能出现的异常情况,避免直接抛出异常;
    • 使用try-catch块来捕获异常,并在catch块中处理异常;
    • 使用自定义的异常类来表示业务相关的异常,避免使用Java内置的异常类。
  4. 数据库访问规范:

    • 使用连接池来管理数据库连接,避免频繁地创建和销毁连接;
    • 使用预编译语句来执行SQL语句,避免SQL注入攻击;
    • 使用事务来保证数据库操作的一致性和完整性。
  5. 文件和目录结构规范:

    • 根据功能将代码组织成不同的包,避免将所有代码都放在同一个包中;
    • 使用Maven或Gradle等构建工具管理项目依赖,避免手动管理依赖。
  6. 单元测试规范:

    • 使用JUnit或其他单元测试框架编写单元测试用例,覆盖核心代码逻辑;
    • 遵循单元测试的原则,每个测试用例都应该是独立的和可重复的。
  7. 安全规范:

    • 对用户输入进行严格的校验和过滤,避免被恶意用户利用漏洞进行攻击;
    • 使用安全组件和框架来增加系统的安全性。

以上是一些企业级后端Java开发规范的主要内容,具体的规范还会根据不同的企业和项目进行一些定制化的调整和优化。

这篇关于java开发规范(刚入行同学必看)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/873896

相关文章

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时,有没有考虑过 JVM 是如何把静态的字节码(byte code)转化为运行时对象的呢,这个问题看似简单,但清楚的同学相信也不会太多,这篇文章首先介绍 JVM 类初始化的机制,然后给出几个易出错的实例来分析,帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段,分别是:loading 、Linking、initialization

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权,允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true (Spring security默认会带有ROLE_前缀),去

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程,特意画了如下的类图,包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口,接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类,它们之间的依赖,构建起了整个框架。想要理解整个架构,最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文(security context)的信息。当前操作的用户是谁,该用户是否已经被认证,他拥有哪些角色权限…这些都被保

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明(认真看哦) AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证,则会调用 #attemptAuthentica

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门(一):登录与退出》 《Spring-Security-入门(二):基于数据库验证》 《Spring-Security-入门(三):密码加密》 《Spring-Security-入门(四):自定义-Filter》 《Spring-Security-入门(五):在 Sprin

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物

这15个Vue指令,让你的项目开发爽到爆

1. V-Hotkey 仓库地址: github.com/Dafrok/v-ho… Demo: 戳这里 https://dafrok.github.io/v-hotkey 安装: npm install --save v-hotkey 这个指令可以给组件绑定一个或多个快捷键。你想要通过按下 Escape 键后隐藏某个组件,按住 Control 和回车键再显示它吗?小菜一碟: <template

Hadoop企业开发案例调优场景

需求 (1)需求:从1G数据中,统计每个单词出现次数。服务器3台,每台配置4G内存,4核CPU,4线程。 (2)需求分析: 1G / 128m = 8个MapTask;1个ReduceTask;1个mrAppMaster 平均每个节点运行10个 / 3台 ≈ 3个任务(4    3    3) HDFS参数调优 (1)修改:hadoop-env.sh export HDFS_NAMENOD

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory