什么是硬编码

• 2023-04-05 14:36:21来源：腾讯云

硬编码是指将特定的值或参数直接写入代码中的做法。这样的代码缺乏灵活性，当需要更改这些值或参数时，开发人员必须手动修改代码。这种方法不仅浪费时间，而且容易出错，并且不利于维护。相反，通过使用配置文件或数据库等外部资源，可以将这些值或参数作为参数传递给代码，并使代码更加灵活。

(相关资料图)

在软件开发中，硬编码是一种常见的错误实践。它不仅会导致代码变得难以维护和扩展，还会降低代码的可重用性。下面，我们将通过几个示例来说明硬编码的问题，并介绍如何避免它。

示例1：硬编码的URL

假设我们正在开发一个Web应用程序，该应用程序需要向外部API发送HTTP请求以获取数据。如果我们将API的URL硬编码到我们的代码中，代码就会变得非常脆弱。任何时间，如果API的URL发生了变化，我们都必须手动更改代码中的URL。如果我们的代码分散在多个地方，这个过程就会变得非常痛苦。

以下是一个使用硬编码URL的示例：

public class ApiClient {    private static final String API_URL = "https://api.example.com";    public ApiResponse callApi(String endpoint) {        String url = API_URL + endpoint;        // 发送HTTP请求并返回响应    }}

复制

在这个例子中，API_URL 被硬编码为字符串常量，而且作为一个私有的静态常量，也就意味着该值在整个类中是可见的。如果我们要修改API的URL，我们需要手动修改该常量的值。

为了避免硬编码的URL，我们可以将URL作为参数传递给 callApi()方法：

public class ApiClient {    public ApiResponse callApi(String apiUrl, String endpoint) {        String url = apiUrl + endpoint;        // 发送HTTP请求并返回响应    }}

复制

在这个例子中，我们将API_URL 变为方法的参数，并使用该参数构建URL。现在，我们可以通过将API_URL传递给该方法来调用该方法。

示例2：硬编码的数据库连接信息

在开发Web应用程序时，我们通常需要访问数据库以获取或保存数据。为了访问数据库，我们需要连接到数据库服务器并执行SQL查询。如果我们将数据库连接信息硬编码到代码中，代码就会变得非常脆弱。

以下是一个使用硬编码数据库连接信息的示例：

public class UserDao {    private static final String DB_URL = "jdbc:mysql://localhost/mydb";    private static final String DB_USERNAME = "root";    private static final String DB_PASSWORD = "password";    public List getAllUsers() {        List userList = new ArrayList<>();        try {            Connection conn = DriverManager.getConnection(DB_URL, DB_USERNAME, DB_PASSWORD);            PreparedStatement stmt = conn.prepareStatement("SELECT * FROM users");            ResultSet rs = stmt.executeQuery();            while (rs.next()) {                User user = new User();                user.setId(rs.getInt("id"));                user.setName(rs.getString("name"));                user.setEmail(rs.getString("email"));                userList.add(user);            }            rs.close();            stmt.close();            conn.close();        } catch (SQLException e) {            e.printStackTrace();        }        return userList;    }}

复制

在这个例子中，DB_URL、DB_USERNAME和DB_PASSWORD都被硬编码为字符串常量。如果我们要连接到不同的数据库或使用不同的用户名和密码，我们必须手动更改这些常量的值。

为了避免硬编码的数据库连接信息，我们可以将这些信息存储在配置文件中，并在运行时从文件中读取这些信息。下面是一个使用配置文件的示例：

public class UserDao {    private static final String CONFIG_FILE = "/path/to/config.properties";    public List getAllUsers() {        List userList = new ArrayList<>();        try {            Properties props = new Properties();            props.load(new FileInputStream(CONFIG_FILE));            String url = props.getProperty("db.url");            String username = props.getProperty("db.username");            String password = props.getProperty("db.password");            Connection conn = DriverManager.getConnection(url, username, password);            PreparedStatement stmt = conn.prepareStatement("SELECT * FROM users");            ResultSet rs = stmt.executeQuery();            while (rs.next()) {                User user = new User();                user.setId(rs.getInt("id"));                user.setName(rs.getString("name"));                user.setEmail(rs.getString("email"));                userList.add(user);            }            rs.close();            stmt.close();            conn.close();        } catch (IOException | SQLException e) {            e.printStackTrace();        }        return userList;    }}

复制

在这个例子中，我们使用一个配置文件存储数据库连接信息。我们可以在运行时读取该文件，并从中获取连接信息。这种方法使我们可以轻松地更改连接信息，而无需修改代码。

标签：

延伸阅读

推荐阅读

猜您喜欢