首页 文章 精选 留言 我的

精选列表

搜索[x265编码],共10012篇文章
优秀的个人博客,低调大师

编码风格:Mvc模式下SSM环境,代码分层管理

本文源码:GitHub·点这里 || GitEE·点这里 一、分层策略 MVC模式与代码分层策略,MVC全名是ModelViewController即模型-视图-控制器,作为一种软件设计典范,用一种业务逻辑、数据、界面显示分离的方法组织代码,将业务逻辑聚集到一个部件里面,在改进和个性化定制界面及用户交互的同时,不需要重新编写业务逻辑,这是一种开发模式,但并不是实际开发中代码的分层模式,通常SSM框架的后端代码分层如下: controller控制层:定义服务端接口,入参出参,和一些入参校验; service业务服务层:组装业务逻辑,业务校验,构建控制层需要的参数模型; dao数据交互层:提供服务层需要的数据查询方法,处理数据交互条件相关的逻辑; mapper持久层:基于mybatis框架需要的原生支持,目前很常用的持久层组件; 二、控制层 1、Rest接口风格 基于资源访问和处理的逻辑,使用不同风格的注解。例如资源新增,更新,查询,删除。 /** * 新增 */ @PostMapping("/insert") public Integer insert (@RequestBody BaseInfo baseInfo){ return baseInfoService.insert(baseInfo); } /** * 更新 */ @PutMapping("/update/{id}") public String update(@PathVariable(value = "id") Integer id, @RequestBody BaseInfo baseInfo) { if (id<1){ return "error"; } baseInfo.setId(id); return "update="+baseInfoService.update(baseInfo); } /** * 主键查询 */ @GetMapping("/detail/{id}") public InfoModel detail(@PathVariable(value = "id") Integer id) { return baseInfoService.detail(id) ; } /** * 主键删除 */ @DeleteMapping("/delete/{id}") public String delete(@PathVariable(value = "id") Integer id) { baseInfoService.delete(id) ; return "SUS" ; } 2、接口复用度 不建议接口高度复用,例如增删改查都各自对接接口即可,基本原则,不同的客户端端操作,对于独立的接口。 /** * 列表加载 */ @GetMapping("/list") public List<BaseInfo> list() { return baseInfoService.list(new BaseInfoExample()) ; } /** * 列表搜索 */ @PostMapping("/search") public List<BaseInfo> search (@RequestParam("userName") String userName, @RequestParam("phone") String phone) { return baseInfoService.search(userName,phone) ; } 例如常见的list接口,list通常都有会按条件加载的search机制,而且搜索的判断条件很复杂,建议分为两个接口,从实际考虑,大部分场景下都是只使用list接口,很少使用search搜索。 3、入参出参 校验客户端必须条件,例如某某条件必填必选等,如果有问题,快速阻断请求链路,做到程序入口控制层拦截返回。 @PutMapping("/update/{id}") public String update(@PathVariable(value = "id") Integer id, @RequestBody BaseInfo baseInfo) { if (id<1){ return "error"; } baseInfo.setId(id); return "update="+baseInfoService.update(baseInfo); } 参数在三个以下,可以直接陈列入参,参数在三个或三个以上可以使用实体类统一封装。 @PostMapping("/search") public List<BaseInfo> search (@RequestParam("userName") String userName, @RequestParam("phone") String phone) { return baseInfoService.search(userName,phone) ; } 4、参数处理 出参格式处理度基本原则,服务器作为公共资源,避免非必要操作,例如客户端可自行判断返回值是否为空,null等,或者一些常见格式处理,利用客户端适当分担服务器压力。 三、业务服务层 1、业务校验 例如传入订单号,经过数据库层查询,没有订单数据,这里称为业务性质的异常,代码本身没有问题,但是业务逻辑无法正常执行。 public InfoModel detail(Integer id){ BaseInfo baseInfo = baseInfoDao.selectByPrimaryKey(id) ; if (baseInfo != null){ DetailInfoEntity detailInfoEntity = detailInfoDao.getById(id); if (detailInfoEntity == null){ LOG.info("id="+id+"数据缺失 DetailInfo"); } return buildModel(baseInfo,detailInfoEntity) ; } LOG.info("id="+id+"数据完全缺失"); return null ; } 2、组装业务逻辑 通常情况下服务层作为逻辑做复杂的一块,用来拼接业务核心步骤,可以通过业务逻辑判定,一步一步执行程序,避免在程序入口做大量可能用到的对象创建和需求数据查询。 public int insert (BaseInfo record){ record.setCreateTime(new Date()); int insertFlag = baseInfoDao.insert(record); if (insertFlag > 0){ DetailInfoEntity detailInfoEntity = new DetailInfoEntity(); detailInfoEntity.setUserId(record.getId()); detailInfoEntity.setCreateTime(record.getCreateTime()); if(detailInfoDao.save(detailInfoEntity)){ return insertFlag ; } } return insertFlag; } 3、数据模型构建 通常情况业务层是偏复杂的,如果想关快速理解业务层,可以对复杂的业务方法,在提供一个返参构建的方法,用来处理服务层要向控制层回传的参数,这样可以让重度的服务层方法变的清晰。 private InfoModel buildModel (BaseInfo baseInfo,DetailInfoEntity detailInfo){ InfoModel infoModel = new InfoModel() ; infoModel.setBaseInfo(baseInfo); infoModel.setDetailInfoEntity(detailInfo); return infoModel ; } 四、数据交互层 1、逆向工程 这里以使用mybatis框架或者mybatis-plus框架作为参考。如果是mybatis框架,建议逆向工程的模板代码不做自定义的修改,如果需要自定义方法,在mapper和xml层面再自定义一个扩展文件,用来存放自定义的方法和SQL逻辑,这样避免表结构变动大引发的强烈不适。 当然现在大部分都会mybatis-plus作为持久层组件,可以避免上述问题。 2、数据交互 针对业务层的需要,提供相应的数据查询方法,只处理与数据库交互的逻辑,避免出现业务逻辑,尤其在分布式架构下,不同服务的数据查询和组装,不应该出现在该层。 public interface BaseInfoDao { int insert(BaseInfo record); List<BaseInfo> selectByExample(BaseInfoExample example); int updateByPrimaryKey(BaseInfo record); BaseInfo selectByPrimaryKey(Integer id); int deleteByPrimaryKey(Integer id); BaseInfo getById (Integer id) ; } 五、源代码地址 GitHub·地址 https://github.com/cicadasmile/data-manage-parent GitEE·地址 https://gitee.com/cicadasmile/data-manage-parent

优秀的个人博客,低调大师

java安全编码指南之:可见性和原子性

简介 java类中会定义很多变量,有类变量也有实例变量,这些变量在访问的过程中,会遇到一些可见性和原子性的问题。这里我们来详细了解一下怎么避免这些问题。 不可变对象的可见性 不可变对象就是初始化之后不能够被修改的对象,那么是不是类中引入了不可变对象,所有对不可变对象的修改都立马对所有线程可见呢? 实际上,不可变对象只能保证在多线程环境中,对象使用的安全性,并不能够保证对象的可见性。 先来讨论一下可变性,我们考虑下面的一个例子: public final class ImmutableObject { private final int age; public ImmutableObject(int age){ this.age=age; } } 我们定义了一个ImmutableObject对象,class是final的,并且里面的唯一字段也是final的。所以这个ImmutableObject初始化之后就不能够改变。 然后我们定义一个类来get和set这个ImmutableObject: public class ObjectWithNothing { private ImmutableObject refObject; public ImmutableObject getImmutableObject(){ return refObject; } public void setImmutableObject(int age){ this.refObject=new ImmutableObject(age); } } 上面的例子中,我们定义了一个对不可变对象的引用refObject,然后定义了get和set方法。 注意,虽然ImmutableObject这个类本身是不可变的,但是我们对该对象的引用refObject是可变的。这就意味着我们可以调用多次setImmutableObject方法。 再来讨论一下可见性。 上面的例子中,在多线程环境中,是不是每次setImmutableObject都会导致getImmutableObject返回一个新的值呢? 答案是否定的。 当把源码编译之后,在编译器中生成的指令的顺序跟源码的顺序并不是完全一致的。处理器可能采用乱序或者并行的方式来执行指令(在JVM中只要程序的最终执行结果和在严格串行环境中执行结果一致,这种重排序是允许的)。并且处理器还有本地缓存,当将结果存储在本地缓存中,其他线程是无法看到结果的。除此之外缓存提交到主内存的顺序也肯能会变化。 怎么解决呢? 最简单的解决可见性的办法就是加上volatile关键字,volatile关键字可以使用java内存模型的happens-before规则,从而保证volatile的变量修改对所有线程可见。 public class ObjectWithVolatile { private volatile ImmutableObject refObject; public ImmutableObject getImmutableObject(){ return refObject; } public void setImmutableObject(int age){ this.refObject=new ImmutableObject(age); } } 另外,使用锁机制,也可以达到同样的效果: public class ObjectWithSync { private ImmutableObject refObject; public synchronized ImmutableObject getImmutableObject(){ return refObject; } public synchronized void setImmutableObject(int age){ this.refObject=new ImmutableObject(age); } } 最后,我们还可以使用原子类来达到同样的效果: public class ObjectWithAtomic { private final AtomicReference<ImmutableObject> refObject= new AtomicReference<>(); public ImmutableObject getImmutableObject(){ return refObject.get(); } public void setImmutableObject(int age){ refObject.set(new ImmutableObject(age)); } } 保证共享变量的复合操作的原子性 如果是共享对象,那么我们就需要考虑在多线程环境中的原子性。如果是对共享变量的复合操作,比如:++, -- *=, /=, %=, +=, -=, <<=, >>=, >>>=, ^= 等,看起来是一个语句,但实际上是多个语句的集合。 我们需要考虑多线程下面的安全性。 考虑下面的例子: public class CompoundOper1 { private int i=0; public int increase(){ i++; return i; } } 例子中我们对int i进行累加操作。但是++实际上是由三个操作组成的: 从内存中读取i的值,并写入CPU寄存器中。 CPU寄存器中将i值+1 将值写回内存中的i中。 如果在单线程环境中,是没有问题的,但是在多线程环境中,因为不是原子操作,就可能会发生问题。 解决办法有很多种,第一种就是使用synchronized关键字 public synchronized int increaseSync(){ i++; return i; } 第二种就是使用lock: private final ReentrantLock reentrantLock=new ReentrantLock(); public int increaseWithLock(){ try{ reentrantLock.lock(); i++; return i; }finally { reentrantLock.unlock(); } } 第三种就是使用Atomic原子类: private AtomicInteger atomicInteger=new AtomicInteger(0); public int increaseWithAtomic(){ return atomicInteger.incrementAndGet(); } 保证多个Atomic原子类操作的原子性 如果一个方法使用了多个原子类的操作,虽然单个原子操作是原子性的,但是组合起来就不一定了。 我们看一个例子: public class CompoundAtomic { private AtomicInteger atomicInteger1=new AtomicInteger(0); private AtomicInteger atomicInteger2=new AtomicInteger(0); public void update(){ atomicInteger1.set(20); atomicInteger2.set(10); } public int get() { return atomicInteger1.get()+atomicInteger2.get(); } } 上面的例子中,我们定义了两个AtomicInteger,并且分别在update和get操作中对两个AtomicInteger进行操作。 虽然AtomicInteger是原子性的,但是两个不同的AtomicInteger合并起来就不是了。在多线程操作的过程中可能会遇到问题。 同样的,我们可以使用同步机制或者锁来保证数据的一致性。 保证方法调用链的原子性 如果我们要创建一个对象的实例,而这个对象的实例是通过链式调用来创建的。那么我们需要保证链式调用的原子性。 考虑下面的一个例子: public class ChainedMethod { private int age=0; private String name=""; private String adress=""; public ChainedMethod setAdress(String adress) { this.adress = adress; return this; } public ChainedMethod setAge(int age) { this.age = age; return this; } public ChainedMethod setName(String name) { this.name = name; return this; } } 很简单的一个对象,我们定义了三个属性,每次set都会返回对this的引用。 我们看下在多线程环境下面怎么调用: ChainedMethod chainedMethod= new ChainedMethod(); Thread t1 = new Thread(() -> chainedMethod.setAge(1).setAdress("www.flydean.com1").setName("name1")); t1.start(); Thread t2 = new Thread(() -> chainedMethod.setAge(2).setAdress("www.flydean.com2").setName("name2")); t2.start(); 因为在多线程环境下,上面的set方法可能会出现混乱的情况。 怎么解决呢?我们可以先创建一个本地的副本,这个副本因为是本地访问的,所以是线程安全的,最后将副本拷贝给新创建的实例对象。 主要的代码是下面样子的: public class ChainedMethodWithBuilder { private int age=0; private String name=""; private String adress=""; public ChainedMethodWithBuilder(Builder builder){ this.adress=builder.adress; this.age=builder.age; this.name=builder.name; } public static class Builder{ private int age=0; private String name=""; private String adress=""; public static Builder newInstance(){ return new Builder(); } private Builder() {} public Builder setName(String name) { this.name = name; return this; } public Builder setAge(int age) { this.age = age; return this; } public Builder setAdress(String adress) { this.adress = adress; return this; } public ChainedMethodWithBuilder build(){ return new ChainedMethodWithBuilder(this); } } 我们看下怎么调用: final ChainedMethodWithBuilder[] builder = new ChainedMethodWithBuilder[1]; Thread t1 = new Thread(() -> { builder[0] =ChainedMethodWithBuilder.Builder.newInstance() .setAge(1).setAdress("www.flydean.com1").setName("name1") .build();}); t1.start(); Thread t2 = new Thread(() ->{ builder[0] =ChainedMethodWithBuilder.Builder.newInstance() .setAge(1).setAdress("www.flydean.com1").setName("name1") .build();}); t2.start(); 因为lambda表达式中使用的变量必须是final或者final等效的,所以我们需要构建一个final的数组。 读写64bits的值 在java中,64bits的long和double是被当成两个32bits来对待的。 所以一个64bits的操作被分成了两个32bits的操作。从而导致了原子性问题。 考虑下面的代码: public class LongUsage { private long i =0; public void setLong(long i){ this.i=i; } public void printLong(){ System.out.println("i="+i); } } 因为long的读写是分成两部分进行的,如果在多线程的环境中多次调用setLong和printLong的方法,就有可能会出现问题。 解决办法本简单,将long或者double变量定义为volatile即可。 private volatile long i = 0; 原文链接 本文为阿里云原创内容,未经允许不得转载。

优秀的个人博客,低调大师

java安全编码指南之:声明和初始化

简介 在java对象和字段的初始化过程中会遇到哪些安全性问题呢?一起来看看吧。 初始化顺序 根据JLS(Java Language Specification)中的定义,class在初始化过程中,需要同时初始化class中定义的静态初始化程序和在该类中声明的静态字段(类变量)的初始化程序。 而对于static变量来说,如果static变量被定义为final并且它值是编译时常量值,那么该static变量将会被优先初始化。 那么使用了final static变量,是不是就没有初始化问题了呢? 我们来看下面一个例子: public class StaticFiledOrder { private final int result; private static final StaticFiledOrder instance = new StaticFiledOrder(); private static final int intValue=100; public StaticFiledOrder(){ result= intValue - 10; } public static void main(String[] args) { System.out.println(instance.result); } } 输出结果是什么呢? 答案是90。 根据我们提到的规则,intValue是final并且被编译时常量赋值,所以是最先被初始化的,instance调用了StaticFiledOrder类的构造函数,最终导致result的值是90。 接下来,我们换个写法,将intValue改为随机变量: public class StaticFiledOrder { private final int result; private static final StaticFiledOrder instance = new StaticFiledOrder(); private static final int intValue=(int)Math.random()* 1000; public StaticFiledOrder(){ result= intValue - 10; } public static void main(String[] args) { System.out.println(instance.result); } } 运行结果是什么呢? 答案是-10。为什么呢? 因为instance在调用StaticFiledOrder构造函数进行初始化的过程中,intValue还没有被初始化,所以它有一个默认的值0,从而导致result的最终值是-10。 怎么修改呢? 将顺序调换一下就行了: public class StaticFiledOrder { private final int result; private static final int intValue=(int)Math.random()* 1000; private static final StaticFiledOrder instance = new StaticFiledOrder(); public StaticFiledOrder(){ result= intValue - 10; } public static void main(String[] args) { System.out.println(instance.result); } } 循环初始化 既然static变量可以调用构造函数,那么可不可以调用其他类的方法呢? 看下这个例子: public class CycleClassA { public static final int a = CycleClassB.b+1; } public class CycleClassB { public static final int b = CycleClassA.a+1; } 上面就是一个循环初始化的例子,上面的例子中CycleClassA中的a引用了CycleClassB的b,而同样的CycleClassB中的b引用了CycleClassA的a。 这样循环引用虽然不会报错,但是根据class的初始化顺序不同,会导致a和b生成两种不同的结果。 所以在我们编写代码的过程中,一定要避免这种循环初始化的情况。 不要使用java标准库中的类名作为自己的类名 java标准库中为我们定义了很多非常优秀的类,我们在搭建自己的java程序时候可以很方便的使用。 但是我们在写自定义类的情况下,一定要注意避免使用和java标准库中一样的名字。 这个应该很好理解,就是为了避免混淆。以免造成不必要的意外。 这个很简单,就不举例子了。 不要在增强的for语句中修改变量值 我们在遍历集合和数组的过程中,除了最原始的for语句之外,java还为我们提供了下面的增强的for循环: for (I #i = Expression.iterator(); #i.hasNext(); ) { {VariableModifier} TargetType Identifier = (TargetType) #i.next(); Statement } 在遍历的过程中,#i其实相当于一个本地变量,对这个本地变量的修改是不会影响到集合本身的。 我们看一个例子: public void noncompliantUsage(){ int[] intArray = new int[]{1,2,3,4,5,6}; for(int i: intArray){ i=0; } for(int i: intArray){ System.out.println(i); } } 我们在遍历过程中,尝试将i都设置为0,但是最后输出intArray的结果,发现没有任何变化。 所以,一般来说我们需要在增强的for语句中,将#i设置成为final,从而消除这种不必要的逻辑误会。 public void compliantUsage(){ int[] intArray = new int[]{1,2,3,4,5,6}; for(final int i: intArray){ } for(int i: intArray){ System.out.println(i); } } 本文的例子: learn-java-base-9-to-20/tree/master/security 本文已收录于 http://www.flydean.com/java-security-code-line-dlc/ 最通俗的解读,最深刻的干货,最简洁的教程,众多你不知道的小技巧等你来发现! 欢迎关注我的公众号:「程序那些事」,懂技术,更懂你!

优秀的个人博客,低调大师

这5个有趣的Python库带你花式编码

云栖号资讯:【点击查看更多行业资讯】在这里您可以找到不同行业的第一手的上云资讯,还在等什么,快来! Python是如今最流行的编程语言之一,这点也给它本身带来很多好处,其中之一就是,为了方便进行程序开发,它拥有了大量优秀的库,如Pandas、Numpy、Matplotlib、SciPy等。 不过,本文不打算介绍那些以实用为主要“卖点”的库,而是带你走进一些极为有趣的库,这些库可以展示Python的另一面,也恰恰证明了Python社区的繁荣发展。 1. Bashplotlib Bashplotlib是一个Python库,使得能够在命令行stdout环境中绘制数据。老实说,第一次看到这个库的时候,笔者很疑惑,我们为什么可能会需要这样的库? 很快笔者就意识到,当没有任何可用的GUI时,它可能会很有用。这个情况可不太常见,它引起了笔者的好奇心。我这是一个非常有趣的Python库。 使用pip就可以很容易地安装Bashplotlib: pipinstall bashplotlib 来看一些例子。在下面的代码中,导入了numpy来生成一些随机数组,当然还有bashplotlib。 importnumpy as np from bashplotlib.histogram import plot_hist arr = np.random.normal(size=1000, loc=0, scale=1) plot_hist是bashplotlib的一个函数,用于在直方图中绘制一维数据,就像plt.hist在Matplotlib中的功能一样。然后,使用Numpy生成一个包含1,000个服从正态分布的数字组成的随机数组。在此之后,可以很容易地绘制这些数据: plot_hist(arr, bincount=50) 输出就像这样: 你也可以从文本文件中用散点图来绘制数据。 2. PrettyTable Bashplotlib在命令行环境中绘制数据,而PrettyTable以一种好看的格式绘制输出结果表。 同样的,使用pip可以很容易地安装这个库: pipinstall prettytable 首先,导入这个库: from prettytable import PrettyTable 然后,使用PrettyTable创建表格对象: table =PrettyTable() 一旦创建表格对象,就可以开始添加域和数据列了: table.field_names= [ Name , Age , City ] table.add_row(["Alice", 20, "Adelaide"]) table.add_row(["Bob", 20, "Brisbane"]) table.add_row(["Chris", 20, "Cairns"]) table.add_row(["David", 20, "Sydney"]) table.add_row(["Ella", 20, "Melbourne"]) 只需打印就可显示表格: print(table) PrettyTable还支持改进表格样式,几乎包括可以想到的任何方面。例如,我们可以右对齐表格中的文字: table.align= r print(table) 按列对表格排序: table.sortby= "City" print(table) 甚至可以得到表格的HTML字符串 3. Colorama 想为命令行应用程序添加一些颜色吗?Colorama可以很容易地输出你喜欢的颜色。 再一次使用pip安装Colorama: pipinstall colorama Colorama支持在“前景”(文本颜色)、“背景”(背景颜色)和“风格”(额外的风格的颜色)中支持渲染输出颜色。可以导入: fromcolorama import Fore, Back, Style 首先使用黄色显示一些警告: 然后尝试使用红色背景显示一些错误: print(Back.RED+ Fore.WHITE + "This is an error!") 红色太艳了。使用“dim”风格。 print(Back.RESET+ Style.DIM + "Another error!") 此处设置“RESET”改变背景颜色为默认。 “DIM”样式使字体不可见。若想把所有东西都恢复正常时,只需将“Style”设置为“RESET_ALL”: print(Style.RESET_ALL) 4. FuzzyWuzzy 很多时候,你可能想为程序实现一个“模糊”搜索功能,FuzzyWuzzy提供了一个开箱即用的轻量级解决方案。 和再去一样,使用pip安装: pip installfuzzywuzzy 导入库: fromfuzzywuzzy import fuzz 做个简单的测试: fuzz.ratio("Let’sdo a simple test", "Let us do a simple test") 如结果所示,“93”表示这两个字符串有93%的相似性,这相当高了。 当有一个字符串列表,想要搜索所有的字符串,FuzzyWuzzy将帮助提取最相关的字符串及其相似性。 fromfuzzywuzzy import processchoices = ["Data Visualisation", "DataVisualization", "Customised Behaviours", "CustomizedBehaviors"]process.extract("data visulisation", choices,limit=2) process.extract("custom behaviour", choices, limit=2) 在上面的示例中,参数limit告诉FuzzyWuzzy提取“前n个”结果。否则将获得具有所有这些原始字符串及其相似性分数的元组列表。 5. TQDM 你通常会使用Python来开发命令行工具吗?如果是的话一定要试试这个库。当CLI工具处理一些耗时的事情时,它将通过显示一个进度条来指示完成了多少工作,帮助你了解情况。 老办法,使用pip安装: pipinstall tqdm 当for循环使用range函数时,只是把它替换为tqdm中的trange即可。 fromtqdm import trangefor i in trange(100): sleep(0.01) 一般来说,对列表做循环。使用tqdm也很容易。 fromtqdm import tqdm for e in tqdm([1,2,3,4,5,6,7,8,9]): sleep(0.5) # Suppose we are doing something with theelements tqdm不仅适用于命令行环境,还适用于iPython / Jupyter Notebook。 在看到Bashplotlib库之前,必须说笔者从来没有在命令行环境中绘制数据的想法。人类发展思想和创造力的多样性从来没有停止过,这让一切事物变得有趣起来。何不去试试呢? 【云栖号在线课堂】每天都有产品技术专家分享!课程地址:https://yqh.aliyun.com/live 立即加入社群,与专家面对面,及时了解课程最新动态!【云栖号在线课堂 社群】https://c.tb.cn/F3.Z8gvnK 原文发布时间:2020-05-28本文作者:读芯术本文来自:“读芯术公众号”,了解相关信息可以关注“读芯术”

优秀的个人博客,低调大师

告别狗屎代码,请记住这 11 条编码秘诀!

这是一篇值得收藏起来,隔三差五就拿来重读的文章!因为作者向你保证,他“遇到的所有糟糕的代码,都是因为没采纳这些实践经验。而任何一段优秀的代码,都采纳了至少部分实践经验。” 还等什么?赶快看看这些经验就是什么吧? 我已经写了20年代码了,在此期间曾与17个团队共事过,使用不同的语言做过数百个项目。 这些项目从最简单的博客网站,到支持每秒3000多次请求的API,还有曾经热卖过的应用。 根据这些经验,再结合我读过的书,我认为编程中最重要的是:可读性。 1.可读性 表面上看来,可读性似乎很主观。不同语言、代码、和团队对于可读性的定义不尽相同。但如果深入本质的话,就会发现代码可读性有一些非常关键的因素。 许多程序员太倾向于计算机了,只要程序能运行就一了百了。尽管是老生常谈,但这种方式完全断绝了人参与的可能性。 最近几个月, 我在努力将这些人为因素提炼成11条写程序的实践经验,专门讨论如何增强可读性并降低复杂度。 我在BaseCode中写过这些详细内容,并将其应用到真实世界的代码片段中。 许多人会认为这些太基础、无关紧要,可以忽视。但我可以向你保证,我遇到的所有糟糕的代码都是因为没采纳这些实践经验。而任何一段优秀的代码都采纳了至少部分实践经验。 2.格式 我们在格式上消耗了太多精力。制表符还是空格,Allman还是K&R。总会有一天,你会意识到格式在编程中并不是最重要的。 选择一种格式,应用到代码中,然后将这个过程自动化。然后就可以重新专注于写代码本身了。 3.代码 所有注释掉的代码块、未使用的变量和无法到达的的代码都是垃圾。他们就像在对读者说,“我不关心这段代码”。 于是恶性循环开始了。日复一日,死代码最终会埋葬你的代码。这正是经典的破窗效应。 必须要找出并干掉死代码。虽然不需要把精力主要放在这里,但一定要时时留意。更多代码规范请看这篇文章《优秀 Java 程序员写代码的风格》。 4.嵌套代码 逻辑几乎是一切代码的基础。我们写代码是为了做决策、迭代和计算。一般情况下都会导致分支或嵌套,从而造成嵌套得很深的代码块。 虽然计算机很容易阅读这种代码,但对于人类则是非常大的精神负担。因此,代码会变得复杂、难以阅读。应该通过防御语句、提前返回或使用函数式编程等方式消灭嵌套代码。 5.使用对象 尽管现在是面向对象编程的时代,我们依然使用了过多的原始指令。 长长的参数列表,杂乱的数据,自定义的数组或字典结构等。这些都可以重构成对象。 这样不仅能让数据结构变得正规,还能容纳所有重复的、使用原始数据的重复的逻辑。 6.大型代码块 虽然没有具体的数字,但代码块的长度应该是有限制的。如果你认为你的代码块过大,就应该对其进行识别、重组并重构。 这个简单的过程可以让你确定代码块的上下文和抽象级别,以便正确地找出代码的任务,并将代码重构到更加易于阅读、更简单的代码块中。 7.命名规则 当然,好的命名很困难,但只是因为我们人为增加了难度。有个小技巧在编程的许多方面都能用得上,包括命名,那就是——延后。不要纠结某个东西的命名,继续写代码就好。 就算是用一整句话命名一个变量都没问题,继续写代码就好。我可以保证,当你完成整个功能之后,更好的名字就会浮出水面。 8.删除注释 在我看来这一条至关重要,删了注释我才能把精力放到可读性上。不管我如何解释删除注释的必要性,总会有人跟我抬杠,然后举出一个绝对需要注释的例子。 当然,如果哈勃望远镜要和古老的适配器连接,而后者返回一个意思不明的687,这种情况肯定需要注释来说明。但大多数其他情况下,你应该尽量重写代码使得它不需要注释也能看懂。 9.合理的返回 我们总是选择返回最奇怪的值,特别是对于边界条件的情况。像-1、687或null。然后就得写很多代码来处理这些值。实际上,null的创造者称它为“10亿美元的错误”。 应该努力返回更有意义的值。理想情况下,最好是即使在反面情况下也能让调用者继续执行的值。如果真的是异常情况,那么最好用其他方式来通信,而不是使用null。 10.三的原则 考虑一下数学上的序列。给出数字2并问你,“下一个数字是什么?”可能是3可能是4,但也可能是1或2.1。实际上你没办法知道。然后我提供了序列中的下一个数字2, 4然后问,“下一个是什么?”可能是6,8,也可能是16。 同样,尽管猜对的可能性增加了,但还是不能确定。然后我提供了数列中的第三个数字,2, 4, 16,然后问“下一个是什么?”有了三个数字之后,程序员的大脑很容易看出这是个平方序列,于是确定下一个数字是256。这就是三的原则。 这个例子虽然跟编程没关系,但它告诉我们,我们不应该太早做抽象。三的原则能阻止我们过早消除重复的努力,直到有了足够多的信息后再做出决定。用Sandi Mets的话说,“重复的代价远远低于错误的抽象。” 11.对称性 最后一条实践经验能给所有代码的可读性带来诗一般的润色,那就是对称性。这条来自Kent Beck的《实现模式》一书,书中说到: 代码中的对称性是说,同样的思想在任何地方都使用同样的实现。 不过说起来容易做起来难。对称性体现了编程的创造性。它是许多其他实践的基础:命名、结构、对象、模式等。不同语言之间、不同代码之间和不同团队之间对于对称性的定义都可能不一样。 因此,你需要花上许多年去追求对称性。但是,一旦开始在代码中使用对称性,就会迅速呈现纯粹的形式,代码的形状也会迅速变好。更多代码规范请看这篇文章《优秀 Java 程序员写代码的风格》。 原文发布时间为:2018-10-10 本文作者:Jason McCreary 本文来自云栖社区合作伙伴“Java技术栈”,了解相关信息可以关注“Java技术栈”。

资源下载

更多资源
腾讯云软件源

腾讯云软件源

为解决软件依赖安装时官方源访问速度慢的问题,腾讯云为一些软件搭建了缓存服务。您可以通过使用腾讯云软件源站来提升依赖包的安装速度。为了方便用户自由搭建服务架构,目前腾讯云软件源站支持公网访问和内网访问。

Rocky Linux

Rocky Linux

Rocky Linux(中文名:洛基)是由Gregory Kurtzer于2020年12月发起的企业级Linux发行版,作为CentOS稳定版停止维护后与RHEL(Red Hat Enterprise Linux)完全兼容的开源替代方案,由社区拥有并管理,支持x86_64、aarch64等架构。其通过重新编译RHEL源代码提供长期稳定性,采用模块化包装和SELinux安全架构,默认包含GNOME桌面环境及XFS文件系统,支持十年生命周期更新。

Sublime Text

Sublime Text

Sublime Text具有漂亮的用户界面和强大的功能,例如代码缩略图,Python的插件,代码段等。还可自定义键绑定,菜单和工具栏。Sublime Text 的主要功能包括:拼写检查,书签,完整的 Python API , Goto 功能,即时项目切换,多选择,多窗口等等。Sublime Text 是一个跨平台的编辑器,同时支持Windows、Linux、Mac OS X等操作系统。

WebStorm

WebStorm

WebStorm 是jetbrains公司旗下一款JavaScript 开发工具。目前已经被广大中国JS开发者誉为“Web前端开发神器”、“最强大的HTML5编辑器”、“最智能的JavaScript IDE”等。与IntelliJ IDEA同源,继承了IntelliJ IDEA强大的JS部分的功能。

用户登录
用户注册