构建可维护的Java软件：未来-proof代码的十大准则

5星 · 超过95%的资源需积分: 32 161 浏览量更新于2024-07-20 1 收藏 5.83MB PDF 举报

"Building.Maintainable.Software.Java.Edition.2016.1.pdf" 是一本关于构建可维护软件的书籍，专注于Java语言。作者Joost Visser提供了十条准则来帮助开发人员编写出能够适应未来变化的代码。在软件开发领域，保持代码的可维护性是至关重要的。这本书《Building Maintainable Software: Ten Guidelines for Future-Proof Code》针对Java程序员，旨在教导如何编写出不仅能满足当前需求，还能适应未来变化的高质量代码。以下是对书中部分准则的详细解释： 1. **明确设计目标**：软件设计应该有明确的目标，考虑长期的需求变化和扩展性。这意味着在编码初期就需要考虑系统的可扩展性和模块化。 2. **保持简洁**：遵循“简单至上”的原则，避免过度复杂的设计和实现。简洁的代码更容易理解、测试和维护。 3. **良好的命名**：使用有意义且一致的命名约定，以便其他开发者可以快速理解代码的功能和意图。 4. **模块化**：将系统分解为独立的、可重用的模块，减少模块间的耦合。这样做可以提高代码的可读性，降低修改和维护的难度。 5. **代码重构**：定期进行代码重构，以保持代码结构清晰，消除技术债务。重构应伴随着自动化测试，确保改动不会引入新的错误。 6. **自动化测试**：编写单元测试和集成测试，确保代码的质量和稳定性。自动化测试可以作为更改代码的防护网，防止破坏现有功能。 7. **文档**：提供足够的文档，包括接口说明、设计决策和使用示例，帮助团队成员理解代码的意图和工作方式。 8. **持续集成与持续部署(CI/CD)**：采用CI/CD流程，确保每次代码变更都能快速地被构建和部署，同时进行自动化测试，及时发现和解决问题。 9. **代码审查**：实施代码审查，提高代码质量，促进团队之间的知识共享，并帮助发现潜在的问题。 10. **监控与反馈**：设置合适的监控机制，收集运行时数据，以便及时了解系统状态，发现并修复性能问题。这本书通过这些准则，帮助Java开发者建立编写可维护软件的实践方法，提升代码的未来适应性。作者Joost Visser的专业见解和实践经验，为读者提供了宝贵的指导，有助于创建出更加健壮和可持续的软件系统。

About This Edition

This is the Java edition of the book. All code examples are in Java (and in Java only),

and the text frequently refers to tools and terms that are widely used in the Java com‐

munity, but not necessarily outside of it. We assume that the reader has experience in

Java programming. As previously noted, the guidelines, while presented in this edi‐

tion in Java, are independent of the programming language used. A C# edition is

being published concurrently by O’Reilly.

Related Books

We present 10 basic guidelines for achieving high maintainability. While it might be

the first book many people will read on the topic of maintainability, we hope it will

certainly not be the last one. We recommend several books as follow-up:

Building

Soware Teams, by the Soware Improvement Group

This is the companion to the current book, written by the same authors. While

the current book focuses on developer guidelines for building maintainable soft‐

ware, this book focuses on development process best practices and how to meas‐

ure them wisely with the Goal-Question-Metric approach. Building

Soware

Teams is scheduled for publication in 2016.

Refactoring: Improving the Design of Existing Code, by Martin Fowler

This book focuses on improving maintainability (and other quality characteris‐

tics) of existing code.

Clean Code: A Handbook of Agile

Soware Crasmanship, by Robert C. Martin (a.k.a.

Uncle Bob)

Like the current book, Clean Code is about building software source code that is

of high quality. Clean Code describes guidelines at a higher level of abstraction.

Code Quality:

e Open Source Perspective, by Diomidis Spinellis

Also like the current book, Code Quality presents guidelines for code quality, but

like Clean Code, they are presented at a higher level of abstraction.

Design Patterns: Elements of Reusable Object-Oriented

Soware, by Erich Gamma,

Richard Helm, Ralph Johnson, and John Vlissides (a.k.a. the Gang of Four)

This is recommended reading for those software developers who want to become

better software architects.

xiv | Preface

readonly for exactly the same thing. As another example, C# provides a feature called

partial classes, which Java (currently) does not provide.

In addition to differences in syntax, programming languages also differ in the termi‐

nology they use in textbooks, tutorials, and their individual specifications. For

instance, the concept of a group of code lines that can be executed as a whole is

known in almost every programming language. In Java and C#, this concept is called

a method. In Visual Basic, it is called a subroutine. In JavaScript and C, it is known as a

function. In Pascal, it is known as a procedure.

That is why a technology-independent model needs generic names for grouping con‐

cepts. Table P-1 presents the generic names that we use throughout the chapters.

Table P-1. A generic grouping of concepts and their representation in Java.

Generic name Generic denition In Java

Unit Smallest grouping of lines that can be executed independently Method or constructor

Module Smallest grouping of units Top-level class, interface, or enum

Component Top-level division of a system as dened by its software architecture (Not dened by the language)

System The entire codebase under study (Not dened by the language)

The following list further clarifies the relationship between the grouping constructs

described in Table P-1 and the practice of Java programming:

From smallest to largest

The grouping concepts in Table P-1 are ordered from smallest to largest. A unit

itself consists of statements, but statements are not a grouping construct.

In Java, as in many other programming languages, there is a com‐

plex relationship between statements and lines in the .java file in

which they appear. A line may have more than one statement, but a

statement can be spread over multiple lines. We simply look at lines

of code (LoC): any line in source code that ends with an Enter/

Return, and neither is empty nor contains only a comment.

Some concepts are not

dened in a particular language

As Table P-1 shows, some generic concepts are not represented in Java. For

instance, in Java there is no syntax to describe the boundaries of a system. This

concept is introduced in the generic terminology because we do need it. It is not

a problem that Java lacks the syntax: in practice we have other ways to determine

these boundaries.

xvi | Preface

Some well-known generic concepts play no role

You might be surprised that Table P-1 does not define well-known terms such as

subcomponent and subsystem. The reason is simple: we do not need them for the

guidelines.

Not all grouping constructs of a language are represented

Java has more grouping constructs than those listed in Table P-1. Java has pack‐

ages to group classes and interfaces. Java also has inner classes. They are not lis‐

ted in Table P-1 because we do not need them for the guidelines. For example, we

do not need to distinguish between classes and inner classes to formulate our

guidelines about coupling.

A Java package is not the same as a component in the generic ter‐

minology. In very small Java systems, there may be a one-to-one

mapping between components and packages. In larger Java sys‐

tems, there are usually far more packages than components.

Build tooling plays no role in the generic terminology

In Java development, teams that use Apache Ant have an additional grouping

concept: targets. Likewise, teams that use Maven may use several POM files, each

for a different part of the system. However, Ant targets and Maven POM files

play no role in the guidelines. There may be a one-to-one relationship between

components on the one hand and targets or POM files on the other, but this is

not a rule.

Components are determined by the architecture of the system

A component is not a Java concept. Components are not packages, nor Ant tar‐

gets or Maven POM files. Instead, components are the highest-level building

blocks as identified by the software architecture of the system. They are the

blocks in a “blocks-and-arrows” diagram of the system. Chapter 7 further

explains the concept of components and presents some examples.

Using Code Examples

Supplemental material (code examples, exercises, etc.) is available for download at

https://github.com/oreillymedia/building_maintainable_soware.

This book is here to help you get your job done. In general, if example code is offered

with this book, you may use it in your programs and documentation. You do not

need to contact us for permission unless you’re reproducing a significant portion of

the code. For example, writing a program that uses several chunks of code from this

book does not require permission. Selling or distributing storage media (e.g., CD-

ROM) of examples from O’Reilly books does require permission. Answering a

Preface | xvii

question by citing this book and quoting example code does not require permission.

Incorporating a significant amount of example code from this book into your pro‐

duct’s documentation does require permission.

We appreciate, but do not require, attribution. An attribution usually includes the

title, author, publisher, and ISBN. For example: “Building Maintainable

Soware: Ten

ment Group B.V., 978-1-4919-5352-5.”

If you feel your use of code examples falls outside fair use or the permission given

above, you may contact us at permissions@oreilly.com for special permission.

Safari® Books Online

Safari Books Online is an on-demand digital library that deliv‐

ers expert content in both book and video form from the

world’s leading authors in technology and business.

Technology professionals, software developers, web designers, and business and crea‐

tive professionals use Safari Books Online as their primary resource for research,

problem solving, learning, and certification training.

Safari Books Online offers a range of plans and pricing for enterprise, government,

education, and individuals.

Members have access to thousands of books, training videos, and prepublication

manuscripts in one fully searchable database from publishers like O’Reilly Media,

Prentice Hall Professional, Addison-Wesley Professional, Microsoft Press, Sams, Que,

Peachpit Press, Focal Press, Cisco Press, John Wiley & Sons, Syngress, Morgan Kauf‐

mann, IBM Redbooks, Packt, Adobe Press, FT Press, Apress, Manning, New Riders,

McGraw-Hill, Jones & Bartlett, Course Technology, and hundreds more. For more

information about Safari Books Online, please visit us online.

How to Contact Us

Please address comments and questions concerning this book to the publisher:

O’Reilly Media, Inc.

1005 Gravenstein Highway North

Sebastopol, CA 95472

800-998-9938 (in the United States or Canada)

707-829-0515 (international or local)

707-829-0104 (fax)

xviii | Preface

剩余167页未读，继续阅读

xinconan2

粉丝: 269
资源: 399

构建可维护的Java软件：未来-proof代码的十大准则

Building Java Programs A Back to Basics Approach 第二版

Building Maintainable Software Java Edition mobi

Building Maintainable Software Java Edition epub

java近几年英文文献,Java演进英文文献和中文翻译

给我找两篇英文文献有关于Java或者springboot框架或者vue的

关于java的外语文献_java英文参考文献（涵盖3年最新120个）

spring-boot

用英语并使用sci期刊的语言风格来说Vue.js的概念和作用

Test-Driven Development

lit-element slim-js

最新资源