写出一份“有理有据使人信服”的Android项目设计文档，程序员怎样优雅度过35岁中年危机-CSDN博客

本文链接：https://blog.csdn.net/m0_54776668/article/details/137189721

这个环节就比较简单了，把该项目的技术难点都列举出来，但是有一个问题要切记：

不要贴源码！不要贴源码！不要贴源码！

很多朋友，包括在写博客的时候都是一言不合直接复制粘贴源码，这样的做法是非常让人讨厌的，说白了就是偷懒，连精炼一下源码，哪怕做一份伪代码加comment的功夫都不肯下。还是那句话，文档是写给别人看的，不是写给自己的。

这里我用KunMinX大哥的博客里面的伪代码做正面例子,大家如果看到这一份安卓事件分发的源代码：

@Override

public boolean dispatchTouchEvent(MotionEvent ev) {

if (mInputEventConsistencyVerifier != null) {

mInputEventConsistencyVerifier.onTouchEvent(ev, 1);

}

// If the event targets the accessibility focused view and this is it, start

// normal event dispatch. Maybe a descendant is what will handle the click.

if (ev.isTargetAccessibilityFocus() && isAccessibilityFocusedViewOrHost()) {

ev.setTargetAccessibilityFocus(false);

}

boolean handled = false;

if (onFilterTouchEventForSecurity(ev)) {

final int action = ev.getAction();

final int actionMasked = action & MotionEvent.ACTION_MASK;

// Handle an initial down.

if (actionMasked == MotionEvent.ACTION_DOWN) {

// Throw away all previous state when starting a new touch gesture.

// The framework may have dropped the up or cancel event for the previous gesture

// due to an app switch, ANR, or some other state change.

cancelAndClearTouchTargets(ev);

resetTouchState();

}

// Check for interception.

final boolean intercepted;

if (actionMasked == MotionEvent.ACTION_DOWN

|| mFirstTouchTarget != null) {

final boolean disallowIntercept = (mGroupFlags & FLAG_DISALLOW_INTERCEPT) != 0;

if (!disallowIntercept) {

intercepted = onInterceptTouchEvent(ev);

ev.setAction(action); // restore action in case it was changed

} else {

intercepted = false;

}

} else {

// There are no touch targets and this action is not an initial down

// so this view group continues to intercept touches.

intercepted = true;

}

// If intercepted, start normal event dispatch. Also if there is already

// a view that is handling the gesture, do normal event dispatch.

if (intercepted || mFirstTouchTarget != null) {

ev.setTargetAccessibilityFocus(false);

}

是不是瞬间没有任何兴趣了？请注意我还没有全部都复制上来，就只是一小段而已。

再看KunMinX大哥的精简版伪代码：

https://juejin.im/post/5d3140c951882565dd5a66ef

是不是瞬间就豁然开朗了。

写文档也是这样，如果我是审查者看到上来就贴项目内部的源代码的设计文档，对不起，我会直接打零分，贴源代码的设计文档，像极了初中的时候为了凑八百字而生硬的加排比句的作文一样，看起来很丰满，其实都是骨头没有肉。

当你自己想钻研技术的时候，一行行的研究源码是没毛病的，但是如果你是要分享给他人的时候，千万别直接复制粘贴。

完成要求

这个环节也不多做介绍，这是和公司/产品内部的需求有关系。比如你做结构的修改，做完之后是否会影响到原有的开发流程，如果有，是否会严重的影响，这些都是需要列出来的。

现有架构和建议架构

一提到架构，很多人都会觉得很虚，感觉无从下手。

其实在这方面，流程图和组件通信图都是很好的帮手。有时候可能自己会觉得无从写起，但是其实只要把流程图/组件通信图一画，其实就豁然开朗了。

这里我以我司的一个最近刚刚开源的移动开发框架 Amplify(aws.amazon.com/cn/amplify/)为例。

假如我在我的最新设计中提议使用这么一个新的框架,那么首先我得阐明这个框架是做什么的(PS:这是我自己总结的，和公司文案无关):

Amplify Mobile sdk 给客户端提供了一套离线应用解决方案，它包括了离线存储，和服务端数据增量更新，还有身份验证，日志发送等等移动端所需的功能。该框架以GraphQL语言为基础，通过WebSocket保持和服务器端的实时连接，还有基于时间戳的增量/全量更新保持客户端和服务端的数据一致。

好了，那你们组的高级工程师可能会问，那这个Amplify Mobile SDK内部是大概怎么实现离线还有和服务器端数据一致性的呢？

这个时候组件通信图就派上用场了。话不多说，先上图 (这里我们用 arcentry.com/app/ 来做示范，这个工具提供了很多AWS相关的服务组件图，比较好上手)。