springboot中的接口实现调用

• 定义接口:
• 实现
• 接口调用
• 分析在类中定义方法也可以在其他类中声明使用,与使用接口的方法相比他们的差异是什么,哪个更合理

springboot中的接口实现调用:

定义接口:

通过创建一个interface的类型的类创建接口

示例:

package app.test4.OpportunityMatching;


import org.springframework.data.repository.CrudRepository;

import java.util.List;

public interface IUserRepository extends CrudRepository<User, Integer> {

    List<User> findByNameAndArea(String name, String area);
}

逐行解析:

public interface IUserRepository extends CrudRepository<User, Integer> {

这是IUserRepository接口的声明，使用extends(继承属性与方法)它扩展了CrudRepository接口，并指定了实体类为User，ID类型为Integer。

List<User> findByNameAndArea(String name, String area);

这是自定义的查询方法findByNameAndArea，它接受两个参数 name 和 area，用于查询符合指定条件的用户列表。

虽然根据方法名，Spring Data JPA会自动生成查询语句

但是我们也可自己定义查询逻辑,实现接口功能

实现

下面对接口进行实现,定义 一个 实现的类UserRepositoryImpl

public abstract class UserRepositoryImpl implements IUserRepository {

    @Autowired
    private EntityManager entityManager;

    @Override
    public List<User> findByNameAndArea(String name, String area) {
        //此处实现方法逻辑
        String queryString = "SELECT u FROM User u WHERE u.name = :name AND u.area = :area";
        TypedQuery<User> query = entityManager.createQuery(queryString, User.class);
        query.setParameter("name", name);
        query.setParameter("area", area);
        return query.getResultList();
    }
}

public abstract class UserRepositoryImpl implements IUserRepository {

这是一个抽象类UserRepositoryImpl，使用implements(实现)实现了IUserRepository接口。

@Autowired
private EntityManager entityManager;

这里使用@Autowired注解将EntityManager自动注入到entityManager字段中。EntityManager用于与数据库进行交互，执行查询和持久化操作。

@Override
public List<User> findByNameAndArea(String name, String area) {
    //此处实现方法逻辑
    String queryString = "SELECT u FROM User u WHERE u.name = :name AND u.area = :area";
    TypedQuery<User> query = entityManager.createQuery(queryString, User.class);
    query.setParameter("name", name);
    query.setParameter("area", area);
    return query.getResultList();
}

这是对findByNameAndArea方法的实现。

在这个方法中，我们使用JPQL（Java Persistence Query Language）语法构建了查询字符串queryString。该查询语句从User实体中选择满足指定条件（name和area）的记录。

然后，我们创建了一个TypedQuery对象，并传递查询字符串和实体类User.class作为参数。接下来，我们使用query.setParameter方法设置查询参数的值，将name和area参数与查询字符串中的占位符进行绑定。

最后，我们调用query.getResultList方法执行查询，并返回查询结果的列表。

接口调用

下面对刚刚的接口实现功能进行简单的调用:

@RestController
@RequestMapping("/user")
public class OpportunityMatching {

    @Qualifier("IUserRepository")
    @Autowired
    private IUserRepository iUserRepository;
    @GetMapping("/users")
    public MessageResponse<List<User>> viewUsersByCriteria(@RequestParam("name") String name, @RequestParam("area") String area) {
        try {
            List<User> users = iUserRepository.findByNameAndArea(name, area);
            if (!users.isEmpty()) {
                return MessageResponse.success(users);
            } else {
                return MessageResponse.error(500, "未找到匹配的用户");
            }
        } catch (Exception e) {
            return MessageResponse.error(500, "查询用户信息失败: " + e.getMessage());
        }
    }

    @GetMapping("/view")
    public MessageResponse<Iterable<User>> viewUsers() {
        try {
            Iterable<User> users = iUserRepository.findAll();
            return MessageResponse.success(users);
        } catch (Exception e) {
            return MessageResponse.error(500, "Failed to retrieve users: " + e.getMessage());
        }
    }

    @PostMapping("/insert")
    public MessageResponse<User> insertUser(@RequestBody User user) {
        try {
            User savedUser = iUserRepository.save(user);
            return MessageResponse.success(savedUser);
        } catch (Exception e) {
            return MessageResponse.error(500, "Failed to insert user: " + e.getMessage());
        }
    }

    @PostMapping("/update/{id}")
    public MessageResponse<User> updateUser(@PathVariable int id, @RequestBody User user) {
        try {
            user.setId(id);
            User updatedUser = iUserRepository.save(user);
            return MessageResponse.success(updatedUser);
        } catch (Exception e) {
            return MessageResponse.error(500, "Failed to update user: " + e.getMessage());
        }
    }
}

分析在类中定义方法也可以在其他类中声明使用,与使用接口的方法相比他们的差异是什么,哪个更合理

在类中定义方法与在接口中定义方法相比，有一些重要的差异和适用场景。

类中定义方法的差异：

类中定义的方法可以具有方法体，即提供实际的方法实现。 类中定义的方法可以被其他类直接调用和使用。 类中定义的方法可以访问类的成员变量和方法，以及通过this关键字引用当前类的实例。

接口中定义方法的特点：

接口中定义的方法没有方法体，只有方法签名，即方法的名称、参数列表和返回类型。 接口中定义的方法需要在实现该接口的类中进行具体的实现。 实现接口的类需要实现接口中定义的所有方法，提供方法的实际实现逻辑。 接口中定义的方法用于描述类应该具有的行为和能力，而不关注具体的实现细节。

相比

一个类可以实现多个接口，从而具备多个接口定义的方法。 哪个更合理取决于你的具体需求和设计目标：

如果你希望定义一个通用的契约或协议，描述类应该具备的行为，而不关注具体的实现细节，那么使用接口更合理。接口允许你定义一组方法签名，而具体的实现由实现接口的类提供。

如果你希望定义一个具体的类，并提供该类的实际方法实现，那么在类中定义方法更合适。类中定义的方法允许你提供方法体，实现具体的逻辑，并可以直接被其他类调用和使用。

在实际项目中，通常会同时使用接口和类来实现不同的需求。接口用于定义抽象的行为和契约，提供一致的编程接口；而类则用于提供具体的实现和功能。

总结起来，接口更适合定义抽象的行为和规范，而类更适合提供具体的实现和功能。根据你的具体需求，你可以选择使用接口、类或两者结合来实现最合理的设计。

本文由 mdnice 多平台发布