• 手写分布式配置中心(二)实现分布式配置中心的简单版本


    这一篇文章比较简单,就是一个增删改查的服务端和一个获取配置的客户端,旨在搭建一个简单的配置中心架构,代码在 https://gitee.com/summer-cat001/config-center

    服务端

    服务端选择用springboot 2.7.14搭建,设计了4个接口/config/insert、/config/update、/config/delete、/config/get。

    Controller层

    Controller层做了请求参数的校验,和对服务层的转发

    1. @RestController
    2. @RequestMapping("/config")
    3. public class ConfigController {
    4. @Autowired
    5. private ConfigService configService;
    6. @PostMapping("/insert")
    7. public Result<Void> insertConfig(@RequestBody ConfigVO configVO) {
    8. Result<ConfigBO> result = checkOpConfig(configVO);
    9. if (result.failed()) {
    10. return Result.resultToFail(result);
    11. }
    12. return configService.insertConfig(result.getData());
    13. }
    14. @PostMapping("/update")
    15. public Result<Void> updateConfig(@RequestBody ConfigVO configVO) {
    16. Result<ConfigBO> result = checkOpConfig(configVO);
    17. if (result.failed()) {
    18. return Result.resultToFail(result);
    19. }
    20. ConfigBO configBO = result.getData();
    21. long id = configVO.getId();
    22. if (id <= 0) {
    23. return Result.fail("配置id错误");
    24. }
    25. configBO.setId(id);
    26. return configService.updateConfig(configBO);
    27. }
    28. @PostMapping("/delete")
    29. public Result<Void> delConfig(@RequestBody ConfigVO configVO) {
    30. long id = configVO.getId();
    31. if (id <= 0) {
    32. return Result.fail("配置id错误");
    33. }
    34. return configService.delConfig(id, 0L);
    35. }
    36. @GetMapping("/get")
    37. public Result<List<ConfigVO>> getAllValidConfig() {
    38. Result<List<ConfigBO>> result = configService.getAllValidConfig();
    39. if (result.failed()) {
    40. return Result.resultToFail(result);
    41. }
    42. return Result.success(result.getData().stream().map(configBO -> {
    43. ConfigVO configVO = new ConfigVO();
    44. configVO.setId(configBO.getId());
    45. configVO.setName(configBO.getName());
    46. configVO.setConfigData(configBO.getConfigData());
    47. configVO.setCreateTime(DateUtil.date2str1(configBO.getCreateTime()));
    48. return configVO;
    49. }).collect(Collectors.toList()));
    50. }
    51. private Result<ConfigBO> checkOpConfig(ConfigVO configVO) {
    52. String name = configVO.getName();
    53. if (name == null || (name = name.trim()).length() == 0) {
    54. return Result.fail("配置名不能为空");
    55. }
    56. JSONObject configData = configVO.getConfigData();
    57. if (configData == null) {
    58. return Result.fail("配置内容不能为空");
    59. }
    60. ConfigBO configBO = new ConfigBO();
    61. configBO.setName(name);
    62. configBO.setConfigData(configData);
    63. return Result.success(configBO);
    64. }
    65. }

    Service层

    Service层做了数据的转换和对dao层的调用,对于这个配置中心数据的存储,我做了两个模式,1是单机模式,2是集群模式。简单的来说就是一个存在数据库中,一个存在本地。根据配置文件中的config.center.mode来指定使用哪种模式

    1. @Service
    2. public class ConfigServiceImpl implements ConfigService {
    3. private ConfigDAO configDAO;
    4. @Autowired
    5. private LocalConfigDAO localConfigDAO;
    6. @Value("${config.center.mode:0}")
    7. private int configCenterMode;
    8. @PostConstruct
    9. public void init() {
    10. ConfigCenterModeEnum configCenterModeEnum = ConfigCenterModeEnum.getEnum(configCenterMode);
    11. if (configCenterModeEnum == null) {
    12. throw new IllegalArgumentException("配置config.center.mode错误");
    13. }
    14. if (configCenterModeEnum == ConfigCenterModeEnum.STANDALONE) {
    15. this.configDAO = localConfigDAO;
    16. }
    17. }
    18. @Override
    19. public Result insertConfig(ConfigBO configBO) {
    20. List configList = configDAO.getAllValidConfig();
    21. if (configList.stream().anyMatch(c -> c.getName().equals(configBO.getName()))) {
    22. return Result.fail("配置名重复");
    23. }
    24. ConfigDO configDO = new ConfigDO();
    25. configDO.setName(configBO.getName());
    26. configDO.setConfigData(configBO.getConfigData().toJSONString());
    27. configDAO.insertConfigDO(configDO);
    28. return Result.success(null);
    29. }
    30. @Override
    31. public Result updateConfig(ConfigBO configBO) {
    32. ConfigDO configDO = new ConfigDO();
    33. configDO.setId(configBO.getId());
    34. configDO.setName(configBO.getName());
    35. configDO.setConfigData(configBO.getConfigData().toJSONString());
    36. configDAO.updateConfig(configDO);
    37. return Result.success(null);
    38. }
    39. @Override
    40. public Result delConfig(long id, long updateUid) {
    41. configDAO.delConfig(id, updateUid);
    42. return Result.success(null);
    43. }
    44. @Override
    45. public Result> getAllValidConfig() {
    46. List configList = configDAO.getAllValidConfig();
    47. return Result.success(configList.stream().map(configDO -> {
    48. ConfigBO configBO = new ConfigBO();
    49. configBO.setId(configDO.getId());
    50. configBO.setName(configDO.getName());
    51. configBO.setCreateTime(configDO.getCreateTime());
    52. configBO.setConfigData(JSON.parseObject(configDO.getConfigData()));
    53. return configBO;
    54. }).collect(Collectors.toList()));
    55. }
    56. }

    DAO层

    DAO层提供了一个接口com.config.center.dao.ConfigDAO。单机和集群模式分别实现这个接口,例如单机模式是com.config.center.dao.impl.LocalConfigDAO实现类(集群模式就是访问数据库,大家估计都用吐了,这个就不多介绍了)。
    单机模式就是将配置文件存储到本地的一个路径中,这个路径根据配置文件的config.center.standalone.path配置来指定,保存的是以配置id为文件名.conf为后缀的文件。其中id是从1开始自增,增加配置接口用了锁,所以id不会重复

    1. @Slf4j
    2. @Repository
    3. public class LocalConfigDAO implements ConfigDAO {
    4. private final Lock insertLock = new ReentrantLock();
    5. @Value("${config.center.standalone.path}")
    6. private String standalonePath;
    7. @Override
    8. public long insertConfigDO(ConfigDO configDO) {
    9. insertLock.lock();
    10. try {
    11. long id = 1;
    12. List<ConfigDO> configList = getAllConfig();
    13. if (!configList.isEmpty()) {
    14. id = configList.get(configList.size() - 1).getId() + 1;
    15. }
    16. configDO.setId(id);
    17. Optional.of(configDO).filter(c -> c.getCreateTime() == null).ifPresent(c -> c.setCreateTime(LocalDateTime.now()));
    18. String configPathStr = standalonePath + "/config";
    19. Files.createDirectories(Paths.get(configPathStr));
    20. Path path = Paths.get(configPathStr + "/" + id + ".conf");
    21. Files.write(path, JSON.toJSONString(configDO).getBytes(StandardCharsets.UTF_8), StandardOpenOption.CREATE_NEW);
    22. return id;
    23. } catch (Exception e) {
    24. throw new RuntimeException(e);
    25. } finally {
    26. insertLock.unlock();
    27. }
    28. }
    29. @Override
    30. public void updateConfig(ConfigDO configDO) {
    31. ConfigDO dbConfigDO = getConfig(configDO.getId());
    32. Optional.ofNullable(dbConfigDO).map(c -> {
    33. c.setName(configDO.getName());
    34. c.setUpdateTime(LocalDateTime.now());
    35. c.setUpdateUid(configDO.getUpdateUid());
    36. c.setConfigData(configDO.getConfigData());
    37. return c;
    38. }).ifPresent(this::updateConfigDO);
    39. }
    40. @Override
    41. public void delConfig(long id, long updateUid) {
    42. ConfigDO dbConfigDO = getConfig(id);
    43. Optional.ofNullable(dbConfigDO).map(c -> {
    44. c.setDeleted(true);
    45. c.setUpdateTime(LocalDateTime.now());
    46. c.setUpdateUid(updateUid);
    47. return c;
    48. }).ifPresent(this::updateConfigDO);
    49. }
    50. @Override
    51. public ConfigDO getConfig(long id) {
    52. List<ConfigDO> configList = getAllConfig();
    53. return configList.stream().filter(c -> c.getId() == id).findFirst().orElse(null);
    54. }
    55. @Override
    56. public List<ConfigDO> getAllValidConfig() {
    57. return getAllConfig().stream().filter(c -> !c.isDeleted()).collect(Collectors.toList());
    58. }
    59. @Override
    60. public List<ConfigDO> getAllConfig() {
    61. File[] files;
    62. File folder = new File(standalonePath + "/config");
    63. if (!folder.exists() || (files = folder.listFiles()) == null) {
    64. return new ArrayList<>();
    65. }
    66. return Arrays.stream(files).map(File::getAbsolutePath)
    67. .filter(p -> p.endsWith(".conf")).map(this::buildConfigDO)
    68. .filter(Objects::nonNull).sorted(Comparator.comparing(ConfigDO::getId)).collect(Collectors.toList());
    69. }
    70. private synchronized ConfigDO buildConfigDO(String path) {
    71. try {
    72. byte[] bytes = Files.readAllBytes(Paths.get(path));
    73. String json = new String(bytes, StandardCharsets.UTF_8);
    74. return JSON.parseObject(json, ConfigDO.class);
    75. } catch (Exception e) {
    76. log.error("buildConfigDO error,path:{}", path, e);
    77. return null;
    78. }
    79. }
    80. private synchronized void updateConfigDO(ConfigDO configDO) {
    81. Path path = Paths.get(standalonePath + "/config/" + configDO.getId() + ".conf");
    82. if (Files.exists(path)) {
    83. try {
    84. Files.write(path, JSON.toJSONString(configDO).getBytes(StandardCharsets.UTF_8), StandardOpenOption.WRITE);
    85. } catch (IOException e) {
    86. log.error("updateConfigDO error configDO:{}", configDO, e);
    87. }
    88. }
    89. }
    90. }

    效果

    到这里就已经完成了服务端的构建了,简单吧,下面看看效果

    新增配置

    获取所有有效配置

    修改配置

    删除配置

    客户端

    客户端就更简单了,就是在启动时通过http调用上面的/config/get接口获取配置,并且赋值给对象的成员变量,之后直接使用这个成员变量即可

    1. public class ConfigCenterClient {
    2. /**
    3. * 服务端地址
    4. */
    5. private String url;
    6. public List<ConfigVO> getAllValidConfig() {
    7. HttpRespBO httpRespBO = HttpUtil.httpGet(url + "/config/get");
    8. if (!httpRespBO.success()) {
    9. throw new IllegalArgumentException("获取配置失败:code:" + httpRespBO.getCode() + ",msg:" + httpRespBO.getMessage());
    10. }
    11. if (httpRespBO.getBody() == null) {
    12. throw new IllegalArgumentException("获取配置失败 body is null:code:" + httpRespBO.getCode() + ",msg:" + httpRespBO.getMessage());
    13. }
    14. Result<?> result = JSON.parseObject(new String(httpRespBO.getBody(), StandardCharsets.UTF_8), Result.class);
    15. if (result.failed()) {
    16. throw new IllegalArgumentException("获取配置失败 result:" + result);
    17. }
    18. return JSON.parseArray(JSON.toJSONString(result.getData()), ConfigVO.class);
    19. }
    20. public void setUrl(String url) {
    21. this.url = url;
    22. }
    23. }
    1. public class ClientTest {
    2. private String userName;
    3. private String userAge;
    4. private List<Object> education;
    5. public ClientTest() {
    6. ConfigCenterClient configCenterClient = new ConfigCenterClient();
    7. configCenterClient.setUrl("http://localhost:8088");
    8. List<ConfigVO> configList = configCenterClient.getAllValidConfig();
    9. configList.stream().map(ConfigVO::getConfigData).map(c -> c.getJSONObject("user")).findFirst().ifPresent(user -> {
    10. this.userName = user.getString("name");
    11. this.userAge = user.getString("age");
    12. this.education = user.getJSONArray("education");
    13. });
    14. }
    15. public String toString() {
    16. return "姓名:" + userName + ",年龄:" + userAge + ",教育经历:" + education;
    17. }
    18. public static void main(String[] args) {
    19. ClientTest clientTest = new ClientTest();
    20. System.out.println(clientTest);
    21. }
    22. }

    这样整个配置中心的简单版本就完成了,不过这样只是在new对象的时候设置了配置的值,但是如果配置中心的配置发生变化后,客户端是无法感知的,为了解决这个问题需要加入配置自动刷新功能,这个我们在下一篇文章中介绍。

  • 相关阅读:
    【天文】基于matlab实现GPS卫星运动仿真附matlab代码
    开槌在即:陈可之油画|《赞红梅》
    【JS 逆向百例】猿人学系列 web 比赛第二题:js 混淆 - 动态 cookie,详细剖析
    Python图像处理丨5种图像处理特效
    ESB+MDM预置样例测试总结
    华为云上安装mysql-5.7.38-极其详细的安装教程
    计算机毕业设计springboot+vue+elementUI基本微信小程序的新冠疫苗预约小程序
    APP稳定性测试-monkey日志分析及内存泄漏分析
    Jmeter基础入门教程【23】--常用功能详解:断言持续时间
    .NET序列化 serializable,反序列化
  • 原文地址:https://blog.csdn.net/cjc000/article/details/136451860