代码评审检查指引

一、代码评审标准

1. 代码可读性：代码应易于阅读和理解，注释应清晰，变量和函数名应具有描述性。
2. 代码规范性：遵循公司或团队的代码规范，包括缩进、命名规则、注释等。
3. 错误处理：代码应充分处理异常和错误，确保程序在遇到问题时能够适当处理。
4. 代码复用：避免重复代码，尽可能使用函数、类和模块来提高代码复用性。
5. 性能优化：考虑代码性能，确保算法和数据结构高效，避免不必要的计算和资源消耗。
6. 安全性和稳定性：确保代码在安全性和稳定性方面没有问题，例如防止SQL注入、XSS攻击等。
7. 测试覆盖率：确保代码有足够的测试覆盖率，包括单元测试、集成测试和功能测试。
8. 代码质量：评估代码质量，确保代码符合预期需求，无缺陷、漏洞和不必要的复杂度。

二、代码评审检查表

以下是一份简单的代码评审检查表，您可以根据实际情况进行调整和补充。

1. **代码可读性**
* 注释是否清晰？
* 变量和函数名是否具有描述性？
2. **代码规范性**
* 是否遵循公司或团队的代码规范？
* 缩进是否一致？
* 命名是否符合规范？
* 是否有不必要的空格或换行？
3. **错误处理**
* 是否充分处理异常和错误？
* 是否使用 try-except 语句？
4. **代码复用**
* 是否避免重复代码？
* 是否使用函数、类和模块来提高代码复用性？
5. **性能优化**
* 是否考虑代码性能？
* 算法和数据结构是否高效？
6. **安全性和稳定性**
* 是否防止SQL注入、XSS攻击等安全问题？
7. **测试覆盖率**
* 是否有足够的测试覆盖率？
* 是否覆盖所有重要场景和分支？
8. **代码质量**
* 代码是否符合预期需求？
* 是否无缺陷、漏洞和不必要的复杂度？

#

**Java开发代码评审检查指引**

**一、代码评审标准**

1. **语法准确性**: 代码应符合Java语言规范，没有语法错误。
2. **注释的适当性**: 适当的注释可以增加代码的可读性，但过多的注释也会降低代码的清晰度。
3. **命名规范**: 类、方法、变量等应采用合适的命名，遵循驼峰命名法。
4. **异常处理**: 代码应正确处理异常，避免程序因异常而中断。
5. **代码结构**: 代码结构应清晰，逻辑应简单明了。
6. **代码复用**: 尽量避免代码重复，合理使用继承、接口和抽象类。
7. **性能优化**: 代码应尽可能高效，避免不必要的计算和资源消耗。
8. **安全性**: 代码应考虑安全性，防止SQL注入、XSS攻击等。
9. **单元测试**: 代码应有单元测试，确保每个功能都经过测试。
10. **代码风格一致性**: 遵循团队或公司的代码风格指南。

**二、代码评审检查表**

以下是一份详细的Java代码评审检查表，你可以根据实际情况进行修改或扩展。

1. **语法准确性**
* 检查是否有任何语法错误或拼写错误。
* 检查是否使用了正确的数据类型。
* 检查是否正确使用了Java关键字。
2. **注释的适当性**
* 是否为类、方法、变量提供了必要的注释？
* 注释是否清晰、简洁并准确描述了代码的功能？
* 是否避免了不必要的注释？
3. **命名规范**
* 检查类名是否以大写字母开头？
* 检查方法名是否以小写字母开头？
* 检查变量名是否遵循驼峰命名法？
4. **异常处理**
* 检查是否正确处理了可能抛出的异常？
* 检查是否对可能抛出异常的代码段进行了适当的注释？
5. **代码结构**
* 检查代码结构是否清晰，逻辑是否简单明了？
* 检查是否有冗余的代码段？
6. **代码复用**
* 检查是否重复实现了相同的功能？
* 检查是否合理使用了继承、接口和抽象类？
7. **性能优化**
* 检查是否有不必要的计算或资源消耗？
* 检查是否有优化的空间？例如，使用合适的数据结构和算法。
8. **安全性**
* 检查是否防止了SQL注入、XSS攻击等安全问题？
9. **单元测试**
* 检查是否有单元测试？
* 检查单元测试的覆盖率是否足够？
10. **代码风格一致性**
* 检查是否遵循了团队或公司的代码风格指南？

#

在Java代码评审检查表中，“性能优化”这一项主要是评估代码的执行效率和资源使用情况。以下是对这一部分的详细解释：

1. **不必要的计算**: 在编写代码时，有时可能会进行一些不必要的计算。例如，如果一个变量在计算后没有被使用，那么这个计算就是不必要的。评审时应检查代码中是否有这类不必要的计算，并考虑是否可以优化。
2. **数据结构选择**: 选择合适的数据结构对代码性能至关重要。例如，如果你经常需要快速查找元素，使用HashMap可能比ArrayList更合适。评审时应检查是否选择了合适的数据结构。
3. **循环优化**: 在循环中，每次迭代都进行一些不必要的操作会导致性能下降。例如，在循环内部创建新的对象或调用数据库等。评审时应检查循环内部的操作，看是否有优化的空间。
4. **缓存**: 如果某些计算的结果不随时间变化或变化很小，可以考虑使用缓存来提高性能。评审时应检查是否利用了缓存来提高性能。
5. **并发和多线程**: 如果代码可以并行化或使用多线程来提高性能，那么应考虑使用并发和多线程。评审时应检查是否使用了合适的并发和多线程策略。
6. **I/O操作优化**: I/O操作（如文件读写、网络请求等）通常是性能瓶颈。评审时应检查是否使用了合适的I/O操作，并考虑是否可以优化。
7. **数据库操作优化**: 如果代码涉及到数据库操作，应检查是否使用了合适的查询和索引，以及是否可以减少数据库操作的次数。
8. **内存使用**: 内存使用情况对性能有很大影响。应检查代码是否避免了内存泄漏，并考虑是否可以减少内存使用。
9. **JVM参数调优**: JVM参数的调优也可以提高代码性能。例如，调整堆大小、选择合适的垃圾收集器等。评审时应考虑是否需要调整JVM参数。
10. **其他系统资源**: 除了CPU、内存和磁盘外，还有其他系统资源（如网络带宽、GPU等）可能影响代码性能。评审时应考虑这些资源的使用情况，并考虑是否可以优化。

在进行性能优化时，通常需要权衡代码的简洁性和可读性与性能之间的关系。因此，评审时不仅要关注性能优化，还要关注代码的可读性和可维护性。

#
在Java代码评审检查表中，“语法准确性”这一项主要是评估代码是否符合Java语言的规范，没有语法错误。以下是对这一部分的详细解释：

1. **关键字和符号的使用**:

	* 确保所有Java关键字（如`public`, `private`, `class`, `interface`等）都被正确使用。
	* 确保所有的括号（`(`, `)`, `{`, `}`, `[`, `]`）都正确匹配。
	* 确保所有的分号（`;`）都放在正确的位置。
2. **数据类型和声明**:

	* 确保所有的变量、常量、方法和类都已正确定义其数据类型。
	* 确保数组的声明和使用是正确的。
3. **访问修饰符**:

	* 确保所有的类、方法和变量的访问修饰符（如`public`, `private`, `protected`）都正确使用。
4. **方法定义**:

	* 确保方法的返回类型与声明一致。
	* 确保方法的参数列表与声明一致。
	* 确保方法的异常列表与声明一致。
5. **控制流语句**:

	* 确保所有的`if`, `for`, `while`, `switch`等语句都正确使用。
	* 确保所有的控制流语句都有正确的括号和分号。
6. **Lambda表达式和匿名内部类**:

	* 确保Lambda表达式和匿名内部类的语法是正确的。
7. **字符串和字符**:

	* 确保字符串连接和转义字符的使用是正确的。
8. **导入语句**:

	* 确保所有需要的类都已导入，没有重复导入。
9. **其他**:
	* 确保所有的注释都是有效的，没有语法错误。
	* 确保所有的代码都没有遗漏的分号、括号或其他符号。
10. **编译错误**: 确保代码没有编译错误，能够成功编译。如果存在编译错误，需要修复这些错误后再进行评审。

代码评查标准

WebUploader文档

# 准备

当前实例使用的软件版本：
```
Nginx 1.24.0
apache-tomcat-8.5.91
```
除了以上的两个软件外，还需要3个jar包。3个jar包都已经放到实例包中tomcat的lib目录下了。
```
jedis-2.5.2.jar
commons-pool2-2.2.jar
tomcat8.5-redis-session-manager.jar
```
下边的3个jar包需要放到tomcat/lib/下，如下图：

![1690977746628.png](/static/img/59300d3a563eb837ac6538643456c6d0.1690977746628.webp)

# 配置相关

## Nginx配置 conf/nginx.conf
```
worker_processes  1;

events {
    worker_connections  1024;
}
http {
    include       mime.types;
    default_type  application/octet-stream;
    sendfile        on;
    keepalive_timeout  65;
    gzip  on;
    upstream xpff{
        server 127.0.0.1:8000 weight=1;
        server 127.0.0.1:8001 weight=1;
        server 127.0.0.1:8002 weight=1;
    }
    server {
        listen       80;
        server_name  localhost;
        location / {
                proxy_pass http://xpff;
                proxy_set_header   Host             $host;
                proxy_set_header   X-Real-IP        $remote_addr;
                proxy_set_header   X-Forwarded-For  $proxy_add_x_forwarded_for;
        }
        error_page   500 502 503 504  /50x.html;
        location = /50x.html {
            root   html;
        }
    }
}
```
## Tomcat配置 conf/context.xml
分别配置tomcat的context.xml，加入下边代码
```
<Valve className="com.s.tomcat.redissessions.RedisSessionHandlerValve" />
<Manager className="com.s.tomcat.redissessions.RedisSessionManager"
    host="127.0.0.1"
    port="6379"
    database="0"
    password="123456"
    maxInactiveInterval="60" />
```
参数说明：
```
className：tomcat8.5-redis-session-manager.jar中类全路径。
host：redis master Ip地址
port：redis master 端口
password：redis密码
database：数据库下标(redis默认从0到15 16个分区)
maxInactiveInterval：session超时时间，单位min(测试无效,该怎么设置和失效原因后续会说明)
```

# 实例：

> 链接：https://pan.baidu.com/s/1R5uJ8V7NLWQVFPx__ZjKYA?pwd=qez0
>
> 提取码：qez0

## 使用实例
解压实例后，会得到如下图：

![image.png](/static/img/f3b649428998c07f82609daa13d77e99.image.webp)、

启动redis：redis305/start.bat
分别启动3个tomcat：apache-tomcat-8.5.91-800[0-2]/bin/startup.bat
启动nginx：nginx-1.24.0/nginx.exe

启动成功后，直接访问：http://localhost/

Nginx+Tomcat集群的会话共享

https://my.vultr.com/

https://msdn.itellyou.cn/

## HCIP 第一次直播课笔记
链接：https://pan.baidu.com/s/1z4Pn84ZJz59TcJq3NbJFLw?pwd=xiao
提取码：xiao
--来自百度网盘超级会员V6的分享

好工具一定要分享给最好的朋友，ProcessOn助您和好友一起高效办公！https://www.processon.com/i/58aba2c6e4b0b1a0233e42a7/?full_name=%E5%90%B4%E5%B4%87%E6%98%8C

https://mvnrepository.com/

## 我的网站

个人网盘：

http: http://nas88.vip3.8x6x.com:808

https: https://nas88.vip3.8x6x.com:4433

网络隧道：http://nas.8x6x.com/index/index

## 开发

spring tool suite (eclipse 4.25) 下载地址
https://download.springsource.com/release/STS4/4.16.0.RELEASE/dist/e4.25/spring-tool-suite-4-4.16.0.RELEASE-e4.25.0-linux.gtk.aarch64.tar.gz

https://download.springsource.com/release/STS4/4.16.0.RELEASE/dist/e4.25/spring-tool-suite-4-4.16.0.RELEASE-e4.25.0-linux.gtk.x86_64.tar.gz

eclipse清华大学开源镜像站 https://mirrors.tuna.tsinghua.edu.cn/eclipse