您的位置:

Hardcoded:细节决定成败

Hardcoded是编程中常用的一个术语,指将程序中的常量或固定值直接写入代码中,而不是通过参数或者配置文件进行读取。它的使用在一些场景下能够提高代码的运行效率和可读性,但是如果使用不当,也可能带来安全隐患和可维护性问题。本文将从几个方面对hardcoded进行详细阐述,帮助大家更好地规范自己的编程习惯。

一、Hardcoded Demo

我们可以先来看一个简单的hardcoded demo,以python语言为例:

def get_today():
    return '2022-01-03'

def generate_report():
    filename = 'report_' + get_today() + '.txt'
    content = 'This is the report generated on ' + get_today() + '.'
    with open(filename, 'w') as f:
        f.write(content)

在这个demo中,get_today()方法返回一个固定的日期字符串,generate_report()方法使用这个方法生成报告文件名和报告内容。这个实现看起来非常简单明了,但是我们需要注意到,如果不使用hardcoded的方式,我们将需要引入datetime库来获取当前时间,这会使得代码变得更加复杂,而使用hardcoded的方式,对于这个特定的场景是完全适用的。

二、Hardcoded Password

之前我们讲到,hardcoded的使用可能会带来安全隐患。比较常见的问题是,将密码等敏感信息直接写入代码中,容易被他人恶意获取。我们来看下面这个简单的java程序:

public class Login {
    private static final String USERNAME = "admin";
    private static final String PASSWORD = "123456";

    public static void main(String[] args) {
        Scanner scanner = new Scanner(System.in);
        System.out.print("Please enter your username:");
        String username = scanner.nextLine();
        System.out.print("Please enter your password:");
        String password = scanner.nextLine();

        if(username.equals(USERNAME) && password.equals(PASSWORD)) {
            System.out.println("Welcome " + username + "!");
        } else {
            System.out.println("Invalid username/password.");
        }
    }
}

在这个程序中,我们直接将用户名和密码以hardcoded的方式写入了代码中,这会使得程序容易受到攻击。我们可以使用配置文件等方式,将敏感信息存储在安全的位置,并且通过读取配置文件的方式获取,这样可以提高代码的安全性。

三、Hardcoded常量

除了上面两个方面,我们还可以在代码中使用hardcoded常量,这对于代码的可读性和维护性有很大的帮助。比如我们将下面这个php登录页面的代码进行修改:

<?php
define('USERNAME','admin');
define('PASSWORD','123456');

session_start();

if(isset($_POST['submit'])) {
    $username = $_POST['username'];
    $password = $_POST['password'];
    if($username == USERNAME && $password == PASSWORD) {
        $_SESSION['username'] = $username;
        header("Location: welcome.php");
    } else {
        echo "Invalid username/password.";
    }
}
?>

<form action="" method="POST">
    <label>Username:</label><input type="text" name="username" required><br/>
    <label>Password:</label><input type="password" name="password" required><br/>
    <button type="submit" name="submit">Login</button>
</form>

我们将用户名和密码定义为常量,这样可以使得代码更加易读易维护。如果后续需要修改用户名和密码,只需要修改常量的定义即可,不需要修改代码中所有的引用,减少了维护成本。

四、小结

本文从三个方面对hardcoded进行了详细的阐述,让我们对这个术语有了更加深入的了解。当然,hardcoded并不是一定要被避免的,我们需要根据具体的场景和需求来决定是否使用。在使用的时候,我们需要注意安全隐患和代码的可读性和维护性,这样才能够提高我们的编程水平。